Expand description
Rustdoc Generation on Target
Native documentation generation for VeridianOS packages. Manages
cargo doc invocation, search index construction, theme configuration,
and HTML output path management with conceptual VFS integration.
Supports single-package, workspace-wide, and cross-referenced documentation builds with configurable themes and a simple HTTP serving configuration for local doc browsing.
Structs§
- DocIndex
- Searchable index of all documented items across one or more crates.
- DocIndex
Stats - Per-kind counts for a
DocIndex. - DocItem
- A single documented item stored in the search index.
- DocServer
Config - Minimal configuration for serving docs over HTTP.
- Rustdoc
Builder - Orchestrates
cargo docinvocations for packages and workspaces. - Rustdoc
Config - Configuration for a rustdoc generation run.
Enums§
- DocItem
Kind - Kind of a documented item (function, struct, etc.)
- DocTheme
- Documentation theme variants
Constants§
- DEFAULT_
DOC_ OUTPUT - Default output directory for generated documentation
- DEFAULT_
DOC_ SERVER_ PORT - Default HTTP port for documentation server
- MAX_
SEARCH_ INDEX_ ITEMS - Maximum number of items in a search index before compaction