Skip to main content

Module rustdoc

Module rustdoc 

Source
Expand description

Utilities for building with rustdoc.

Re-exportsยง

use crate::compiler::build_runner::BuildRunner; ๐Ÿ”’
use crate::compiler::unit::Unit; ๐Ÿ”’
use crate::compiler::BuildContext; ๐Ÿ”’
use crate::compiler::CompileKind; ๐Ÿ”’
use crate::context::RustdocExternMap; ๐Ÿ”’
use crate::context::RustdocExternMode; ๐Ÿ”’
use crate::sources::CRATES_IO_REGISTRY; ๐Ÿ”’
use crate::util::errors::CargoResult; ๐Ÿ”’
use crate::util::errors::internal; ๐Ÿ”’
use cargo_util::ProcessBuilder; ๐Ÿ”’
use cargo_util::collections::HashMap; ๐Ÿ”’
use cargo_util::collections::HashSet; ๐Ÿ”’
use url::Url; ๐Ÿ”’

Enumsยง

RustdocScrapeExamples
Indicates whether a target should have examples scraped from it by rustdoc. Configured within Cargo.toml and only for unstable feature -Zrustdoc-scrape-examples.

Functionsยง

add_output_format
Adds unstable flag --output-format to the given rustdoc invocation. This is for unstable feature -Zunstable-features.
add_root_urls
Adds unstable flag --extern-html-root-url to the given rustdoc invocation. This is for unstable feature -Zrustdoc-map.
build_all_urls ๐Ÿ”’
Recursively generate html root url for all units and their children.