Skip to main content

Module docs

Module docs 

Source
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§

doc_cleaning

Structs§

CliSurface
DocsRenderContext
McpSurface

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_output or the docs/reference default. Relative to the workspace root; callers join it under the base directory.