Struct DocsTreeBuilder 

pub struct DocsTreeBuilder { /* private fields */ }

A builder for a DocsTree which represents the docs directory.

Implementations

impl DocsTreeBuilder

pub fn new(root: impl AsRef<Path>) -> Self

Create a new docs tree builder.

pub fn maybe_homepage(self, homepage: Option<impl Into<PathBuf>>) -> Self

Set the homepage for the docs with an option.

pub fn homepage(self, homepage: impl Into<PathBuf>) -> Self

Set the homepage for the docs.

pub fn maybe_custom_theme(self, theme: Option<impl AsRef<Path>>) -> Result<Self>

Set the custom theme for the docs with an option.

pub fn custom_theme(self, theme: impl AsRef<Path>) -> Result<Self>

Set the custom theme for the docs.

pub fn maybe_logo(self, logo: Option<impl Into<PathBuf>>) -> Self

Set the custom logo for the left sidebar with an option.

pub fn logo(self, logo: impl Into<PathBuf>) -> Self

Set the custom logo for the left sidebar.

pub fn maybe_alt_logo(self, logo: Option<impl Into<PathBuf>>) -> Self

Set the alt (i.e. light mode) custom logo for the left sidebar with an option.

pub fn alt_logo(self, logo: impl Into<PathBuf>) -> Self

Set the alt (i.e. light mode) custom logo for the left sidebar.

pub fn additional_javascript(self, js: AdditionalScript) -> Self

Set the additional javascript for each page.

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

Set whether the “Full Directory” view should be initialized instead of the “Workflows” view of the left sidebar.

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

Set whether light mode should be the initial view instead of dark mode.

pub fn build(self) -> Result<DocsTree>

Build the docs tree.

Trait Implementations

impl Debug for DocsTreeBuilder

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

Formats the value using the given formatter.