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
Recommended editing flow¶
- Update Markdown files in
docs/. - Preview locally.
- Check code blocks, Mermaid diagrams, and LaTeX rendering.
- Run
mkdocs build --strict. - Commit docs with source changes.