Skip to content

Docs: executable Jupyter notebooks + Python API reference (myst-nb + autodoc) #135

Description

@grzanka

Part of #130. Complements the prose guide in #116 (purpose/role) with hands-on, runnable Python docs.

Context

The Sphinx site (docs/source, pydata-sphinx-theme, deployed by .github/workflows/docs.yml) currently has no executable examples or generated Python API reference. With a first-class Python package (companion issues), we want runnable notebooks and an autogenerated API reference, executed in CI so docs can never go stale.

Proposed change

Acceptance criteria

  • myst-nb + autodoc wired into the Sphinx build; API reference generated from docstrings.
  • Notebooks execute cleanly in CI against the built wheel (failures break the docs build).
  • Installation page (pip + extras) and notebook gallery published to GitHub Pages.
  • Binder/Colab entry points work.

References

Complements #116 · depends on the nanobind core + scientific-layer issues under #130 · relates to #117, #79.


Filed via Claude Code (model: Claude Opus 4.8) as part of the libdedx → libamtrack integration & Python-packaging plan.

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions