Module
PuduLangDocgen.Build
A complete, validated site plan from loaded project content
Types
| Name | Description |
|---|---|
Input |
Everything a build reads, already loaded from the project |
Extensions |
Caller transforms applied to pages and to the finished outputs |
Built |
The validated plan with the pages and navigation it came from |
Functions
| Name | Description |
|---|---|
extensions |
Extensions that change nothing. |
plan |
The site plan, or every error found. Warnings travel with a successful plan; nothing is planned for output unless the whole site validates. |
site |
The site plan with its pages and resolved tables of contents, for work that continues from a built site such as printable documents. |
extensions
fn extensions() -> Extensions
Extensions that change nothing.
Returns
plan
fn plan(input: &Input, extending: &Extensions) -> Result[Docgen.Plan, Array[Docgen.Diagnostic]]
The site plan, or every error found. Warnings travel with a successful plan; nothing is planned for output unless the whole site validates.
Parameters
input&Inputextending&Extensions
Returns
Result[Docgen.Plan, Array[Docgen.Diagnostic]]
site
fn site(input: &Input, extending: &Extensions) -> Result[Built, Array[Docgen.Diagnostic]]
The site plan with its pages and resolved tables of contents, for work that continues from a built site such as printable documents.
Parameters
input&Inputextending&Extensions
Returns
Result[Built, Array[Docgen.Diagnostic]]