russell@unturf.com
49607a5997
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.
18 lines
375 B
Makefile
18 lines
375 B
Makefile
# Sphinx documentation build Makefile
|
|
|
|
.PHONY: help clean html text
|
|
|
|
help:
|
|
@echo "Sphinx documentation build targets:"
|
|
@echo " make html - build HTML documentation"
|
|
@echo " make text - build text documentation"
|
|
@echo " make clean - remove build artifacts"
|
|
|
|
html:
|
|
sphinx-build -b html . _build/html
|
|
|
|
text:
|
|
sphinx-build -b text . _build/text
|
|
|
|
clean:
|
|
rm -rf _build/
|