Documentation

Our documentation is written in MyST Markdown. To install the packages needed to build the documentation, you need to install the docs optional dependencies. When you're in the repository directory simply execute:

pip install -e.[docs]

All of the documentation is in the docs directory. They are built using Sphinx, see the Makefile in case you're curious how exactly. In general, you should be able to build the documentation inside the docs directory via:

make html

and then open the documentation using:

make view