Skip to main content

Crate docgen_build

Crate docgen_build 

Source
Expand description

The reusable site-build pipeline: discover -> render -> emit the whole docs/ tree into an output dir. Both docgen build and the dev server (docgen-server) call build_site, so the pipeline lives here once rather than inline in the bin.

build_site loads an optional docgen.toml (docgen-config) and builds a custom-component registry (docgen-components: embedded built-ins overridden by a project components/ dir). Config gates the graph/search/math/mermaid features and supplies the site title/base; the registry drives directive rendering and per-page component asset emission.

Structs§

BuildOptions
Inputs to a full site build.
BuildOutcome
Result of a build (counts for logging; extend later if needed).

Enums§

BuildMode
Whether this build is for static distribution or for the dev server.

Functions§

build
Back-compat thin wrapper used by docgen build: builds root/docs into root/dist in Production mode. Equivalent to the old build::build(root).
build_site
Discover -> render -> emit the whole site into opts.out_dir. This is the single pipeline both docgen build and docgen dev call.