Skip to main content

Module generators

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 catalog generator: docs/reference/catalog.md from the facade’s own module re-export lists.
cli
The cli generator: docs/reference/cli.md from the real command line.
environment
The environment generator: docs/reference/environment.md from the env::var call sites, filtered through an explicit allow-list (D34).
errors
The errors generator: docs/reference/errors.md from the Error enum.
features
The features generator: docs/reference/features.md from the manifests.
journal
The journal generator: docs/reference/journal-format.md from the record types and the committed byte golden.
pystub
pystub — the three Python package stubs under crates/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-dsl generator: docs/reference/space-dsl.md from the parser’s and the derive’s own documentation.