Skip to main content

write_reference_tree

Function write_reference_tree 

Source
pub fn write_reference_tree(out_dir: &Path) -> Result<()>
Expand description

Write the full reference tree under out_dir.

The tree holds the broker pages, the concepts pages, and the section indexes. This function overwrites existing files.

The operator CRD pages are not here. The operator crate lives in krabka-io/krabka-operator, so its reference pages are rendered there.

ยงErrors

Returns an error if any directory cannot be created or any file cannot be written.