Crate gruel_doc 

ADR-0089: gruel’s documentation surface.

Inputs: a merged Ast + the ThreadedRodeo used to intern its identifiers. Outputs: a DocSite — one file per input file, each containing rendered per-item pages in either Markdown or HTML.

Re-exports

pub use markdown::render_markdown;

pub use html::render_html;

pub use links::LinkTable;

Modules

html

ADR-0089 Phase 4: HTML rendering via pulldown-cmark.

links

ADR-0089 Phase 5: intra-doc link rewriting.

markdown

ADR-0089 Phase 3: Markdown rendering.

Structs

DocFile

A single file’s rendered documentation.

DocItem

One renderable item with the URL stem we use to address it.

DocSite

A renderable site composed of one entry per source file.

ItemDetail

Type-specific information used to render a richer page than just # name + docstring. Anything not modelled here falls back to the bare name + doc rendering.

NamedDoc

A name + (optional) doc pair, used for nested items.

Enums

ItemKind

Top-level item kind (used in the rendered headers).