Struct rustdoc::config::RenderOptions

pub(crate) struct RenderOptions {
    pub(crate) output: PathBuf,
    pub(crate) external_html: ExternalHtml,
    pub(crate) id_map: IdMap,
    pub(crate) playground_url: Option<String>,
    pub(crate) sort_modules_alphabetically: bool,
    pub(crate) themes: Vec<StylePath>,
    pub(crate) extension_css: Option<PathBuf>,
    pub(crate) extern_html_root_urls: BTreeMap<String, String>,
    pub(crate) default_settings: HashMap<String, String>,
    pub(crate) resource_suffix: String,
    pub(crate) enable_minification: bool,
    pub(crate) enable_index_page: bool,
    pub(crate) index_page: Option<PathBuf>,
    pub(crate) static_root_path: Option<String>,
    pub(crate) markdown_no_toc: bool,
    pub(crate) markdown_css: Vec<String>,
    pub(crate) markdown_playground_url: Option<String>,
    pub(crate) generate_search_filter: bool,
    pub(crate) document_private: bool,
    pub(crate) document_hidden: bool,
    pub(crate) unstable_features: UnstableFeatures,
}

Configuration options for the HTML page-creation process.

Fields

output: PathBuf

Output directory to generate docs into. Defaults to doc.

external_html: ExternalHtml

External files to insert into generated pages.

id_map: IdMap

A pre-populated IdMap with the default headings and any headings added by Markdown files processed by external_html.

playground_url: Option<String>

If present, playground URL to use in the "Run" button added to code samples.

Be aware: This option can come both from the CLI and from crate attributes!

sort_modules_alphabetically: bool

Whether to sort modules alphabetically on a module page instead of using declaration order. true by default.

themes: Vec<StylePath>

List of themes to extend the docs with. Original argument name is included to assist in displaying errors if it fails a theme check.

extension_css: Option<PathBuf>

If present, CSS file that contains rules to add to the default CSS.

extern_html_root_urls: BTreeMap<String, String>

A map of crate names to the URL to use instead of querying the crate's html_root_url.

default_settings: HashMap<String, String>

A map of the default settings (values are as for DOM storage API). Keys should lack the rustdoc- prefix.

resource_suffix: String

If present, suffix added to CSS/JavaScript files when referencing them in generated pages.

enable_minification: bool

Whether to run the static CSS/JavaScript through a minifier when outputting them. true by default.

enable_index_page: bool

Whether to create an index page in the root of the output directory. If this is true but enable_index_page is None, generate a static listing of crates instead.

index_page: Option<PathBuf>

A file to use as the index page at the root of the output directory. Overrides enable_index_page to be true if set.

static_root_path: Option<String>

An optional path to use as the location of static files. If not set, uses combinations of ../ to reach the documentation root.

markdown_no_toc: bool

Whether to generate a table of contents on the output file when reading a standalone Markdown file.

markdown_css: Vec<String>

Additional CSS files to link in pages generated from standalone Markdown files.

markdown_playground_url: Option<String>

If present, playground URL to use in the "Run" button added to code samples generated from standalone Markdown files. If not present, playground_url is used.

generate_search_filter: bool

If false, the select element to have search filtering by crates on rendered docs won't be generated.

document_private: bool

Document items that have lower than pub visibility.

document_hidden: bool

Document items that have doc(hidden).

unstable_features: UnstableFeatures

Trait Implementations

impl Clone for RenderOptions

pub fn clone(&self) -> RenderOptions

Returns a copy of the value.

pub fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for RenderOptions

pub fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.