Struct BuildWarning 

pub struct BuildWarning {
    pub file: PathBuf,
    pub line: Option<usize>,
    pub message: String,
    pub warning_type: WarningType,
    pub category: Option<String>,
}

Fields

file: PathBuf

line: Option<usize>

message: String

warning_type: WarningType

category: Option<String>

Sphinx’s type.subtype warning category (toc.not_readable, toc.not_included, …), which show_warning_types — on by default since Sphinx 8.3 — appends to the rendered message as [category].

None for warnings Sphinx logs without a type (its SphinxLoggerAdapter only appends the suffix when type is set, so a subtype-only warning such as the toctree empty_glob one prints bare). See util/logging.py:545-549.

Implementations

impl BuildWarning

pub fn new( file: PathBuf, line: Option<usize>, message: String, warning_type: WarningType, ) -> Self

pub fn with_category(self, category: Option<String>) -> Self

Attach Sphinx’s type.subtype category (see BuildWarning::category).

pub fn render(&self) -> String

The warning as sphinx-build prints it: path[:line]: WARNING: message[ [type.subtype]].

One renderer for every sink (stderr, -w warning file, the environment-oracle differential) so a message can only ever be formatted one way.

An empty file is a warning Sphinx logs with no location at all (the intersphinx “failed to reach any of the inventories” report, for one): those print as a bare WARNING: ..., with no location prefix and no stray colon.

pub fn broken_cross_reference( file: PathBuf, line: Option<usize>, reference: &str, ) -> Self

Trait Implementations

impl Clone for BuildWarning

fn clone(&self) -> BuildWarning

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BuildWarning

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

Formats the value using the given formatter.