generate_rust_doc

nomicon

Function generate_rust_doc 

Source 
pub fn generate_rust_doc(workspace_root: &Path) -> Result<Output, Box<CmdError>>
Expand description

Runs cargo doc with strict warning enforcement across the workspace.

Executes cargo doc --all --no-deps --document-private-items in the specified workspace root, setting RUSTDOCFLAGS=-Dwarnings to treat documentation warnings as errors.

ยงErrors

  • If the cargo doc command fails or exits with a non-zero status.
  • If documentation warnings are present (due to -Dwarnings).