Struct Docs 

pub struct Docs<'a> {
    pub suite: &'a Suite,
    pub analysis: &'a Analysis,
    pub plans: &'a [Plan],
    pub report: Option<&'a Report>,
    pub suite_dir: Option<&'a Path>,
    pub siblings: &'a [Sibling],
    pub outline: Option<&'a Outline>,
}

Fields

suite: &'a Suite

analysis: &'a Analysis

plans: &'a [Plan]

report: Option<&'a Report>

Results of running plans, if they ran.

suite_dir: Option<&'a Path>

Where the suite’s files are, so each page can link to the one to edit.

siblings: &'a [Sibling]

The other platforms’ docs (when the suite has several), so each page can offer the same page there. Their trees are platforms/<name>/ (the default platform’s is the root).

outline: Option<&'a Outline>

The manual’s parts and hand-written pages. Set by the docs themselves from the suite’s outline.txt; leave it None.

Implementations

impl Docs<'_>

pub fn write(&self, dir: &Path) -> Result<Vec<PathBuf>>

Write the Markdown pages and the HTML site under dir. Pages of stories or features that no longer exist are removed (only the generated kinds, in the folders this writes to); other files in the directory are left alone.

pub fn pages(&self) -> Vec<Page>

pub fn sibling(&self) -> Sibling

This manual’s HTML pages, for the other platforms’ dropdowns.