Skip to content

Documentation

Nolwenn Bernard edited this page Jan 11, 2023 · 1 revision

The documentation is built with sphinx-multiversion using the .rst files in this folder. You can build the documentation and examine how it is displayed locally before making changes.

Note: you need to install the requirements in requirements/docs_requirements.txt.

To build the documentation locally use the following command:

sphinx-multiversion docs/source build/html

This will create the documentation for each version of the package in the folder build/html.

Clone this wiki locally