From bd5e1b7736f406cdffaef08c593761c46b5f8aab Mon Sep 17 00:00:00 2001 From: Shyue Ping Ong Date: Mon, 29 Jul 2024 17:43:33 +0800 Subject: [PATCH] Update dev docs --- docs/monty.functools.md | 3 +++ docs/monty.os.md | 1 + docs/monty.re.md | 2 ++ pyproject.toml | 2 +- tasks.py | 2 +- tests/test_files/3000_lines.txt.gz | Bin 6496 -> 6496 bytes 6 files changed, 8 insertions(+), 2 deletions(-) diff --git a/docs/monty.functools.md b/docs/monty.functools.md index 93fd41b68..15bc0fca9 100644 --- a/docs/monty.functools.md +++ b/docs/monty.functools.md @@ -73,10 +73,13 @@ becomes The decorated main accepts two new arguments: > prof_file: Name of the output file with profiling data + > ```none > If not given, a temporary file is created. > ``` + > sortby: Profiling data are sorted according to this value. + > ```none > default is “time”. See sort_stats. > ``` diff --git a/docs/monty.os.md b/docs/monty.os.md index 96184b2e2..8d85d1dc8 100644 --- a/docs/monty.os.md +++ b/docs/monty.os.md @@ -15,6 +15,7 @@ performing some tasks, and returns to the original working directory afterwards. E.g., > with cd(“/my/path/”): + > ```none > do_something() > ``` diff --git a/docs/monty.re.md b/docs/monty.re.md index b7e419ef9..7082093fb 100644 --- a/docs/monty.re.md +++ b/docs/monty.re.md @@ -25,9 +25,11 @@ A powerful regular expression version of grep. * **Returns** > {key1: [[[matches…], lineno], [[matches…], lineno], + > ```none > [[matches…], lineno], …], > ``` + > key2: …} For reverse reads, the lineno is given as a -ve number. Please note diff --git a/pyproject.toml b/pyproject.toml index 980489faf..59739061e 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -21,7 +21,7 @@ classifiers = [ dependencies = [ ] -version = "2024.7.12" +version = "2024.7.29" [project.optional-dependencies] ci = [ diff --git a/tasks.py b/tasks.py index 82fd73e65..2f09a444b 100755 --- a/tasks.py +++ b/tasks.py @@ -31,7 +31,7 @@ def make_doc(ctx: Context) -> None: with cd("docs"): ctx.run("rm monty.*.rst", warn=True) - ctx.run("sphinx-apidoc --separate -P -M -d 6 -o . -f ../monty") + ctx.run("sphinx-apidoc --separate -P -M -d 6 -o . -f ../src/monty") # ctx.run("rm monty*.html", warn=True) # ctx.run("sphinx-build -b html . ../docs") # HTML building. ctx.run("sphinx-build -M markdown . .") diff --git a/tests/test_files/3000_lines.txt.gz b/tests/test_files/3000_lines.txt.gz index fc12565a89e0c323b849abb7f5ca2e13247025a0..68fddb6075ff603116c2335f2839de459e5587f7 100644 GIT binary patch delta 16 XcmaE0^uUN+zMF%?Hf8xn_DD$pGEoIs delta 16 XcmaE0^uUN+zMF%i-f7}S_DD$pGUWwg