Documentation developmentΒΆ

First, make sure that the necessary dependencies for building documentation are installed:

pip install '.[docs]'

The following command builds the documentation:

make -C docs html

The resulting documentation build will be available in docs/build/html.

Instead, you can also use make -C docs serve to (re-)build the docs and start a local server, which can be accessed on http://localhost:8000.

The following command deletes previously built documentation:

make -C docs clean