How To¶

Get Started¶

Documentation is authored in this project's docs/ directory.

To build and serve docs locally:

python -m pip install -r docs/requirements-mkdocs.txt
python -m mkdocs serve --config-file mkdocs.yml --dev-addr 0.0.0.0:9000

If you prefer just commands:

just docs-serve

Build a Static Site¶

python -m mkdocs build --config-file mkdocs.yml --clean

The generated site is written to site/.

Docstrings and API Docs¶

MkDocs does not generate API pages from Python docstrings by default.

If you want auto-generated API references as part of this migration, add an MkDocs API plugin later (for example mkdocstrings) and keep API content in a separate section under docs/.