Expand description
API reference documentation generator for alef polyglot bindings.
Generates per-language api-{lang}.md files plus shared configuration.md
and errors.md files from the alef IR (ApiSurface).
Re-exports§
pub use doc_cleaning::clean_doc;
Modules§
Structs§
Functions§
- doc_
type - generate_
docs - Generate API reference documentation for the given languages.
- generate_
docs_ stage - Generate the complete docs stage and hand back everything rendered, paired with whatever error (if any) stopped it going further.
- generate_
docs_ stage_ without_ snippet_ compile_ validation - Same as
generate_docs_stage, except it never spawns a compiler, interpreter, or type-checker for a snippet. - reference_
output_ dir - The reference-docs output directory for
config—[docs].reference_outputor thedocs/referencedefault. Relative to the workspace root; callers join it under the base directory.