Skip to content

Commit

Permalink
Ignore (suggested) docs dir -- not just html (#68)
Browse files Browse the repository at this point in the history
* Ignore (suggested) docs dir -- not just html

* Improve writing
  • Loading branch information
patnr authored Aug 21, 2024
1 parent 4dc5ac9 commit 090462e
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 5 deletions.
2 changes: 1 addition & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -143,7 +143,7 @@ cython_debug/
.idea/

#documentation
*.html
docs-generated/

# mergetoolfiles
*.orig
8 changes: 4 additions & 4 deletions docs/dev_guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,8 +25,8 @@ To *live preview* your changes, do
pdoc -t docs/templates --docformat=numpy --math pipt popt misc ensemble simulator input_output docs/dev_guide.py docs/tutorials.py
```

This will probably open a browser window with the rendered html.
You can also ctrl/cmd-cick the printed localhost link, or simply copy-paste it into your browser.
This should open a browser window with the rendered html.
You can also ctrl/cmd-click the printed localhost link, or simply copy-paste it into your browser.

If you want to reproduce errors that occur in **CI**, you'll want to include the option `-o docs-generated `.
Since this actually generates html *files*, it will processes **all** of the files by default
Expand All @@ -36,12 +36,12 @@ Since this actually generates html *files*, it will processes **all** of the fil
(it simply quits with a traceback).
We therefore use my (`patnr`) fork which

- skips the markdown conversion,
- skips the markdown conversion for the erroneous docstring,
- prints the specific docstring that causes issues.

## Tests

Th test suite is orchestrated using `pytest`. Both in **CI** and locally.
The test suite is orchestrated using `pytest`. Both in **CI** and locally.
I.e. you can run the tests simply by the command

```sh
Expand Down

0 comments on commit 090462e

Please sign in to comment.