Documentation

For documentation we use sphinx and MyST. This allows us to write markdown files and include them in the documentation. You can find all documentation files in the docs folder.

You may build the documentation locally with.

# Install the requirements
cd backend
pip install -e .[docs]
# Build the documentation
cd ../docs
make html

This will create a docs/build/html folder with the documentation. You can open the index.html file in any browser to view the documentation.