Skip to content

Commit

Permalink
docs: add a comment on the numpydoc docstring format style used when
Browse files Browse the repository at this point in the history
documenting the code
  • Loading branch information
hagau committed Jun 6, 2024
1 parent 1f2b6a5 commit 2e9e0d9
Showing 1 changed file with 8 additions and 2 deletions.
10 changes: 8 additions & 2 deletions docs/source/documentation.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,19 @@
# Documentation

This project is documented using
This project documentation is generated using
[Sphinx](https://www.sphinx-doc.org)
and
[numpydoc](https://numpydoc.readthedocs.io).
The numpydoc formatting style as documented in the
[style guide](https://numpydoc.readthedocs.io/en/latest/format.html)
is used. See the
[example](https://numpydoc.readthedocs.io/en/latest/example.html#example) in
the numpydoc documentation on how to properly document the code.

The theme being used is [Read the Docs Sphinx Theme](https://sphinx-rtd-theme.readthedocs.io).

To generate the documentation (in HTML format, see `doc/Makefile` for other formats), execute:
```
cd docs
make html
```
```

0 comments on commit 2e9e0d9

Please sign in to comment.