actions
/
mdBook
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

upd doc string

This commit is contained in:
Gambhiro 2017-01-15 10:15:08 +00:00
parent 34ee6c9274
commit 985745531c
1 changed files with 6 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
src/renderer/mod.rs
View File

@ -8,9 +8,12 @@ use std::path::PathBuf;
pub trait Renderer {
/// Responsible for creating an `MDBook` struct from path, preparing the
/// project and calling `render()`, doing what is necessary for the
/// particular output format.
/// When the output format is determined (by a CLI argument for example),
/// call `.build()` of the selected Renderer implementation.
///
/// Constructs an `MDBook` struct given the path of the book project,
/// preparing the project and calling `render()`, doing what is necessary
/// for the particular output format.
///
/// This involves parsing config options from `book.toml` and parsing the
/// `SUMMARY.md` of each translation to a nested `Vec<TocItem>`.