Writing and building documentation¶

The documentation is built using MkDocs with the Material for MkDocs theme.

The documentation is written in Markdown format which is simple to learn and easy to read.

How to edit the documentation¶

All documentation is in the docs folder. The navigation structure is defined in mkdocs.yml at the project root.

Edit or add files in this directory to edit the documentation. When adding new files, remember to add them to the nav section in mkdocs.yml.

From the project root, run:

make docs

Or directly with MkDocs:

uv run mkdocs build

The built documentation will be in the site directory. Open site/index.html to view it.

For a live preview that auto-reloads when you make changes:

uv run mkdocs serve

Then open http://127.0.0.1:8000 in your browser.

API documentation is auto-generated from Python docstrings using mkdocstrings. The API reference is in docs/api/index.md.