Everything needed for a rendered API reference already exists: every public function has a NumPy-style docstring that documents the mathematics, not just the types. There is simply no site.
What to do
- MkDocs Material +
mkdocstrings[python]
- pages: getting started, the 13 tutorials (via
mkdocs-jupyter), the DESIGN document, the codebase tour, and an auto-generated API reference
- GitHub Pages deploy on release
Notes
Keep it a presentation of existing content — the docstrings and notebooks are the source of truth and must not be duplicated. The build should fail on a broken reference so docs cannot rot silently, the same way CI already executes every notebook.
Everything needed for a rendered API reference already exists: every public function has a NumPy-style docstring that documents the mathematics, not just the types. There is simply no site.
What to do
mkdocstrings[python]mkdocs-jupyter), the DESIGN document, the codebase tour, and an auto-generated API referenceNotes
Keep it a presentation of existing content — the docstrings and notebooks are the source of truth and must not be duplicated. The build should fail on a broken reference so docs cannot rot silently, the same way CI already executes every notebook.