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§
- Build
Options - Inputs to a full site build.
- Build
Outcome - Result of a build (counts for logging; extend later if needed).
Enums§
- Build
Mode - Whether this build is for static distribution or for the dev server.
Functions§
- build
- Back-compat thin wrapper used by
docgen build: buildsroot/docsintoroot/distin Production mode. Equivalent to the oldbuild::build(root). - build_
site - Discover -> render -> emit the whole site into
opts.out_dir. This is the single pipeline bothdocgen buildanddocgen devcall.