Module generators
Expand description
The generators themselves — one module per page.
Each is a GeneratedDoc over a registry the code already keeps: clap’s
command tree, the manifests’ [features] tables, the Error enum. None of
them reads a hand-written list, because a hand-written list is the thing that
goes stale (D29, docs/design/11-documentation-plan.md §7, constraint 1).
Modules§
- api_
links api-links—docs/api_links.yml, the checked API-link map of §3 point 3.- catalog
- The
cataloggenerator:docs/reference/catalog.mdfrom the facade’s own module re-export lists. - cli
- The
cligenerator:docs/reference/cli.mdfrom the real command line. - environment
- The
environmentgenerator:docs/reference/environment.mdfrom theenv::varcall sites, filtered through an explicit allow-list (D34). - errors
- The
errorsgenerator:docs/reference/errors.mdfrom theErrorenum. - features
- The
featuresgenerator:docs/reference/features.mdfrom the manifests. - journal
- The
journalgenerator:docs/reference/journal-format.mdfrom the record types and the committed byte golden. - pystub
pystub— the three Python package stubs undercrates/atune_py/python/atune, composed from the live module and an explicit annotation table (D27,docs/design/11-documentation-plan.md§8).- space_
dsl - The
space-dslgenerator:docs/reference/space-dsl.mdfrom the parser’s and the derive’s own documentation.