Goal
Keep the documented API complete, searchable, and synchronized with the symbols consumers are promised.
Background
Manually maintained API pages are easy to omit or drift. A generated reference is necessary for adoption and the v1.0 stability promise.
Scope
Choose and configure a documentation generator; expose supported public modules, classes, and functions; add docstrings and examples for every exported symbol; link the reference from README/PyPI; add strict CI checks for missing symbols and broken links.
Acceptance Criteria
- Every supported exported symbol has a generated page with signature, behavior, errors, and an example.
- Docs build with no warnings or broken links.
- CI fails when the public surface changes without docs.
- Private internals stay private.
Validation
Build docs locally and in CI; run the public-symbol inventory and link checks; verify representative rendered pages.
Non-Goals
Do not promise undocumented internals or expand the supported API solely to satisfy the generator.
Project Fields
- Status: Backlog
- Priority: P2
- Area: Docs
- Initiative: v1.0 Readiness
- Size: M
Ownership
Goal
Keep the documented API complete, searchable, and synchronized with the symbols consumers are promised.
Background
Manually maintained API pages are easy to omit or drift. A generated reference is necessary for adoption and the v1.0 stability promise.
Scope
Choose and configure a documentation generator; expose supported public modules, classes, and functions; add docstrings and examples for every exported symbol; link the reference from README/PyPI; add strict CI checks for missing symbols and broken links.
Acceptance Criteria
Validation
Build docs locally and in CI; run the public-symbol inventory and link checks; verify representative rendered pages.
Non-Goals
Do not promise undocumented internals or expand the supported API solely to satisfy the generator.
Project Fields
Ownership