pub struct Config { /* private fields */ }Expand description
Configuration for documentation generation.
Implementations§
Source§impl Config
impl Config
Sourcepub fn new(
analysis_config: AnalysisConfig,
workspace: impl Into<PathBuf>,
output_dir: impl Into<PathBuf>,
) -> Self
pub fn new( analysis_config: AnalysisConfig, workspace: impl Into<PathBuf>, output_dir: impl Into<PathBuf>, ) -> Self
Create a new documentation configuration.
Sourcepub fn homepage(self, homepage: Option<PathBuf>) -> Self
pub fn homepage(self, homepage: Option<PathBuf>) -> Self
Overwrite the config’s homepage with the new value.
Sourcepub fn init_light_mode(self, init_light_mode: bool) -> Self
pub fn init_light_mode(self, init_light_mode: bool) -> Self
Overwrite the config’s light mode default with the new value.
Sourcepub fn custom_theme(self, custom_theme: Option<PathBuf>) -> Self
pub fn custom_theme(self, custom_theme: Option<PathBuf>) -> Self
Overwrite the config’s custom theme with the new value.
Sourcepub fn custom_logo(self, custom_logo: Option<PathBuf>) -> Self
pub fn custom_logo(self, custom_logo: Option<PathBuf>) -> Self
Overwrite the config’s custom logo with the new value.
Sourcepub fn alt_logo(self, alt_logo: Option<PathBuf>) -> Self
pub fn alt_logo(self, alt_logo: Option<PathBuf>) -> Self
Overwrite the config’s alternate logo with the new value.
Sourcepub fn additional_javascript(
self,
additional_javascript: AdditionalScript,
) -> Self
pub fn additional_javascript( self, additional_javascript: AdditionalScript, ) -> Self
Overwrite the config’s additional JS with the new value.
Sourcepub fn prefer_full_directory(self, prefer_full_directory: bool) -> Self
pub fn prefer_full_directory(self, prefer_full_directory: bool) -> Self
Overwrite the config’s init_on_full_directory with the new value.
Trait Implementations§
Auto Trait Implementations§
impl Freeze for Config
impl RefUnwindSafe for Config
impl Send for Config
impl Sync for Config
impl Unpin for Config
impl UnwindSafe for Config
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
Converts
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
Converts
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read more