Struct PyRefContext 

pub struct PyRefContext {
    pub module: Option<String>,
    pub class_: Option<String>,
    pub span: Span,
}

The slice of env.ref_context that type_to_xref copies onto every annotation xref (_annotations.py:62-66): the enclosing py:module / py:class, or Python None when unset — which docutils pformat renders as the "True" sentinel (same convention as the inline parser’s role xrefs, src/rst/inline.rs) — plus the provenance the built nodes carry.

Fields

module: Option<String>

class_: Option<String>

span: Span

The span every node this context builds is stamped with: the enclosing desc_signature‘s, i.e. the directive’s own (source, line). Sphinx gives annotation xrefs no provenance of their own, and a resolution warning on one then locates through docutils’ get_source_line ancestor walk — which stops at the signature, because ObjectDescription.run calls set_source_info(signode). Stamping the signature’s span directly yields the same location without depending on the walk, and keeps the include case exact (an annotation inside an included file names THAT file). A Span::ZERO (line 0) means “unstamped”, which the resolver treats as “locate at the nearest stamped ancestor”.

Trait Implementations

impl Clone for PyRefContext

fn clone(&self) -> PyRefContext

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PyRefContext

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

Formats the value using the given formatter.

impl Default for PyRefContext

fn default() -> PyRefContext

Returns the “default value” for a type.

impl Eq for PyRefContext

impl PartialEq for PyRefContext

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for PyRefContext