The documentation is automatically deployed to Github Pages whenever commits are pushed to Github. To generate the documentation locally, follow these steps:
- In your Python environment & from the repository base directory, run
pip install -r docs/requirements.txtto install the dependencies. - Run
sphinx-multiversion docs docs/_build/html. (This builds the docs for all versions / branches.) - Alternatively, run
sphinx-build docs docs/_build/html. (This builds the docs only for the current version / branch.)