Struct Config 

pub struct Config { /* private fields */ }

Configuration for documentation generation.

Implementations

impl Config

pub fn new( analysis_config: AnalysisConfig, workspace: impl Into<PathBuf>, output_dir: impl Into<PathBuf>, ) -> Self

Create a new documentation configuration.

pub fn index_page(self, index_page: Option<PathBuf>) -> Self

Overwrite the config’s index page with the new value.

pub fn init_light_mode(self, init_light_mode: bool) -> Self

Overwrite the config’s light mode default with the new value.

pub fn custom_theme(self, custom_theme: Option<PathBuf>) -> Self

Overwrite the config’s custom theme with the new value.

pub fn custom_logo(self, custom_logo: Option<PathBuf>) -> Self

Overwrite the config’s custom logo with the new value.

pub fn external_urls(self, external_urls: ExternalUrls) -> Self

Overwrite the config’s external URLs with the new value.

pub fn alt_logo(self, alt_logo: Option<PathBuf>) -> Self

Overwrite the config’s alternate logo with the new value.

pub fn additional_html(self, additional_html: AdditionalHtml) -> Self

Overwrite the config’s additional HTML with the new value.

pub fn enable_doc_comments(self, enable_doc_comments: bool) -> Self

Enable support for documentation comments.

NOTE: This is an experimental option, and will be removed in a future major release.

For more information, see the pre-RFC discussion here.

Trait Implementations

impl Debug for Config

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

Formats the value using the given formatter.