engineering/arborist
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

docs: add Sphinx API reference generation from docstrings

Browse source 
Implements Read the Docs infrastructure to generate API documentation
directly from code docstrings. Replaces static modules.md (1200+ lines).

New structure:
- docs/_source/conf.py — Sphinx configuration (furo theme)
- docs/_source/index.rst — Main TOC
- docs/_source/api/*.rst — Module groups (substrate, storage, retrieval,
  qa, distill, mesh, cli)
- docs/_source/Makefile — Local build targets
- docs/_source/README.md — Documentation on building and extending

Makefile integration:
- make docs-api — generate HTML (output: docs/_source/_build/html/)
- make docs-api-clean — remove build artifacts

Build output (40 HTML files):
- API module reference with docstrings
- Source code links (:viewcode: extension)
- Full-text search index
- Module index (genindex, py-modindex)

Sphinx installed in venv as dev dependency. HTML is browseable at
docs/_source/_build/html/index.html (open in browser after build).

This justifies the deletion of modules.md: code docstrings + Sphinx
autodoc = automatically-generated, always-current API reference.
This commit is contained in:
russell@unturf.com 2026-05-04 07:55:34 -04:00
parent 92c53c94bb
commit 49607a5997
No known key found for this signature in database
95 changed files with 38287 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

8
docs/_source/api/cli.rst Normal file
View file

@ -0,0 +1,8 @@
CLI: Command-line interface
============================
Entry point for all aborist operations.
.. automodule:: aborist.cli
:members:
:undoc-members: