Contributing Documentation

To generate documentation pages, you can install the necessary dependencies using:

pip install -e '.[docs]'

Sphinx generates the API documentation from the numpydoc-style docstring of the respective modules/classes/functions. You can build the documentation locally using the respective tox environment:

tox -e docs

It will appear in the build/docs directory`. Please note that in order to reproduce the documentation locally, you may need to install pandoc. If necessary, please refer to the installation guide for detailed instructions.

To rebuild the full documentation use

tox -e docs -- -aE