Struct ToctreeContent 

pub struct ToctreeContent<'a> {
    pub content: &'a [String],
    pub docname: &'a str,
    pub glob: bool,
    pub reversed: bool,
    pub source: u16,
    pub line: u32,
    pub found_docs: &'a BTreeSet<String>,
    pub source_suffixes: &'a [&'a str],
    pub exclude_patterns: &'a [String],
}

Everything one toctree directive needs resolved against the project’s document set — the inputs of TocTree.parse_content.

Fields

content: &'a [String]

The directive’s content lines, with blank ones already removed.

docname: &'a str

The containing document.

glob: bool

reversed: bool

source: u16

Source-table index of the .. toctree:: marker’s line (the node’s source): every diagnostic below is stamped with it.

line: u32

1-based line of the .. toctree:: marker. Sphinx logs every diagnostic below with location=toctree, i.e. the directive node’s source info — not the offending entry’s own line.

found_docs: &'a BTreeSet<String>

Every docname the project discovered (sphinx env.found_docs).

source_suffixes: &'a [&'a str]

source_suffix, in configuration order; the first is what doc2path appends for a document that does not exist.

exclude_patterns: &'a [String]

exclude_patterns, which decide whether a missing entry is reported as excluded or as nonexisting.

Trait Implementations

impl<'a> Clone for ToctreeContent<'a>

fn clone(&self) -> ToctreeContent<'a>

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<'a> Copy for ToctreeContent<'a>

impl<'a> Debug for ToctreeContent<'a>

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

Formats the value using the given formatter.