Building documentation and examples#

In the docs directory, run:

make html

On Windows:

.\make.bat html

Sphinx will build the documentation in a few steps. This is generally useful, as it means only part of the documentation needs to be rebuilt after some changes. However, to start afresh, run:

python clean.py

This will get rid of all files generated by Sphinx.

Creating the docs can also be done using pixi. Run the following command to build it:

pixi run --environment default docs