Skip to content

Commit

Permalink
Update dev docs
Browse files Browse the repository at this point in the history
  • Loading branch information
shyuep committed Jul 29, 2024
1 parent e63e57d commit bd5e1b7
Show file tree
Hide file tree
Showing 6 changed files with 8 additions and 2 deletions.
3 changes: 3 additions & 0 deletions docs/monty.functools.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
> ```
Expand Down
1 change: 1 addition & 0 deletions docs/monty.os.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ performing some tasks, and returns to the original working directory
afterwards. E.g.,

> with cd(“/my/path/”):
> ```none
> do_something()
> ```
Expand Down
2 changes: 2 additions & 0 deletions docs/monty.re.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ classifiers = [
dependencies = [

]
version = "2024.7.12"
version = "2024.7.29"

[project.optional-dependencies]
ci = [
Expand Down
2 changes: 1 addition & 1 deletion tasks.py
Original file line number Diff line number Diff line change
Expand Up @@ -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 . .")
Expand Down
Binary file modified tests/test_files/3000_lines.txt.gz
Binary file not shown.

0 comments on commit bd5e1b7

Please sign in to comment.