Struct DocsTree

pub struct DocsTree { /* private fields */ }

A tree representing the docs directory.

Implementations

impl DocsTree

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

Create a new docs tree.

pub fn new_with_stylesheet( root: impl AsRef<Path>, stylesheet: impl AsRef<Path>, ) -> Result<Self>

Create a new docs tree with a stylesheet.

pub fn stylesheet(&self) -> Option<&PathBuf>

Get the absolute path to the stylesheet.

pub fn stylesheet_relative_to<P: AsRef<Path>>(&self, path: P) -> Option<PathBuf>

Get a relative path to the stylesheet.

pub fn add_page<P: Into<PathBuf>>(&mut self, abs_path: P, page: Rc<HTMLPage>)

Add a page to the tree.

pub fn get_page<P: AsRef<Path>>(&self, abs_path: P) -> Option<Rc<HTMLPage>>

Get the page associated with a path.

pub fn render_sidebar_component<P: AsRef<Path>>(&self, path: P) -> Markup

Render a sidebar component given a path.

The sidebar will contain a table of contents for the docs directory. Every node in the tree will be visited in a Depth First Traversal order. If the node has a page associated with it, a link to the page will be rendered. If the node does not have a page associated with it, the name of the node will be rendered. All links will be relative to the given path.

pub fn render_all(&self) -> Result<()>

Render every page in the tree.

pub fn write_page<P: Into<PathBuf>>( &self, page: &HTMLPage, path: P, ) -> Result<()>

Write a page to disk at the designated path.

Trait Implementations

impl Debug for DocsTree

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

Formats the value using the given formatter.