arborist/docs/_source/index.rst
russell@unturf.com 546fa6d690
docs: auto-generate Makefile reference page for RTD
Adds a Sphinx extension at docs/_source/_ext/makefile_targets.py that
parses the project Makefile's '## description' annotations and writes
docs/_source/api/makefile.rst at build time. Same convention 'make help'
uses, so the reference stays in sync with the source.

Generated page is grouped by target prefix (fetch-, ingest-, distill-,
docs-, etc.) and rendered as a list-table. Shows on RTD alongside the
autodoc API modules.

Generated file is gitignored — RTD regenerates on every build.
2026-05-04 08:26:27 -04:00

27 lines
377 B
ReStructuredText

Aborist API Reference
=====================
Generated from docstrings. Replaces the static modules.md.
Contents:
.. toctree::
:maxdepth: 3
:caption: API Modules
api/makefile
api/substrate
api/storage
api/retrieval
api/qa
api/distill
api/mesh
api/cli
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`