Skip to main content

build_docs

Function build_docs 

Source
pub fn build_docs(
    config: &DocsConfig,
    config_dir: &Path,
    template_dir: &Path,
) -> Result<BuildStats>
Expand description

Build a documentation site from the given configuration.

config_dir is the directory containing config.json. It is used to resolve relative paths declared in the config (such as a custom page’s state_file).

One-shot variant for the CLI build command. The dev server uses build_docs_with_cache so the syntect highlighter survives across rebuilds.