Skip to content

Documentation Workflow

Install docs dependencies

python -m pip install mkdocs mkdocs-material pymdown-extensions "mkdocstrings[python]"

Preview locally

python -m mkdocs serve -f mkdocs.yml

Build strictly

python -m mkdocs build --strict

Deploy manually

python -m mkdocs gh-deploy --force
  1. Update Markdown files in docs/.
  2. Preview locally.
  3. Check code blocks, Mermaid diagrams, and LaTeX rendering.
  4. Run mkdocs build --strict.
  5. Commit docs with source changes.