Building the documentation

To install dependencies for building the docs:

$ pip install -e .[docs]

To build and serve the HTML docs:

$ cd docs
$ make livehtml

Note

If you need to specify the hostname/port manually (e.g. you are using a remote machine), you can run e.g. make livehtml O="--host=$(hostname) --port=8000".

Regenerating the API docs

Since sphinx.ext.apidoc was only added in Sphinx 8.2, which also dropped support for Python 3.10, you must manually regenerate the API docs when necessary:

$ make apidoc