Documentation generation

To generate the Sphinx documentation, run the following command:

tox -e docs-local

If everything runs correctly, open the file docs/build/html/index.html with your file browser to read the generated documentation (although the command itself should have already opened a tab in Firefox).

Note

The napoleon extension is used to parse the docstrings. This extension is used to parse Google-style docstrings, which are the ones recommended to use in this project. For more information about the Google-style docstrings, see this page.