-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: add a comment on the numpydoc docstring format style used when
documenting the code
- Loading branch information
Showing
1 changed file
with
8 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 | ||
``` | ||
``` |