Struct NumberingWarning 

pub struct NumberingWarning {
    pub docname: String,
    pub toctree_index: usize,
    pub message: String,
    pub category: Option<String>,
}

One diagnostic from assign_section_numbers.

Sphinx logs it with location=toctreenode, which renders as the containing document’s source:line. A Node in this crate carries byte offsets, not line numbers, so the location is reported as the containing docname plus the ordinal of the toctree node within that document (document order) — enough for the builder to look the line up in the document’s parse records.

Fields

docname: String

The document containing the toctree node the warning is about.

toctree_index: usize

That node’s 0-based ordinal among the document’s toctree nodes, in document order.

message: String

The message, formatted exactly as Sphinx formats it.

category: Option<String>

Sphinx’s type.subtype category; see crate::error::BuildWarning::category.

Trait Implementations

impl Clone for NumberingWarning

fn clone(&self) -> NumberingWarning

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for NumberingWarning

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

Formats the value using the given formatter.

impl Eq for NumberingWarning

impl PartialEq for NumberingWarning

fn eq(&self, other: &NumberingWarning) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for NumberingWarning