Skip to main content

Module doc

Module doc 

Source
Expand description

Documentation generation: schema + intent + comments → Markdown, searchable HTML, and man pages (C-048, spec/docgen.md). Secret values render redacted in every format (C-036).

Structs§

DocItem
One documented configuration item: a dotted value path with its type, value, and prose.

Functions§

collect_items
Collect documentation items depth-first in source order from the evaluated value tree, enriched with schema data, annotations, and attached comments.
doc_to_html
One page with inline CSS and a filter box: typing hides non-matching .field blocks (substring, case-insensitive).
doc_to_man
Man page: .TH header, .SH NAME summary, one .TP entry per item with type/required/value/description body lines.
doc_to_markdown
Reference page: # Title, one ## table section per top-level table (## General for root scalars), ### path items with a type/required/default/value line, description paragraphs, constraint bullets, and deprecation quotes.