sphinx.transforms.post_transforms.ReferencesResolver

class documentation

class ReferencesResolver(SphinxPostTransform): (source)

Known subclasses: sphinx.ext.intersphinx.IntersphinxRoleResolver

View In Hierarchy

Resolves cross-references on doctrees.

Method find_pending_xref_condition Undocumented
Method resolve_anyref Resolve reference generated by the "any" role.
Method run Main method of post transforms.
Method warn_missing_reference Undocumented
Class Variable default_priority Undocumented

Inherited from SphinxPostTransform:

Method apply Undocumented
Method is_supported Check this transform working for current builder.
Class Variable builders Undocumented
Class Variable formats Undocumented

Inherited from SphinxTransform (via SphinxPostTransform):

Property app Reference to the :class:`.Sphinx` object.
Property config Reference to the :class:`.Config` object.
Property env Reference to the :class:`.BuildEnvironment` object.
def find_pending_xref_condition(self, node, conditions): (source)

Undocumented

Parameters
node:pending_xrefUndocumented
conditions:Sequence[str]Undocumented
Returns
list[Node]|NoneUndocumented
def resolve_anyref(self, refdoc, node, contnode): (source)

Resolve reference generated by the "any" role.

Parameters
refdoc:strUndocumented
node:pending_xrefUndocumented
contnode:ElementUndocumented
Returns
Element|NoneUndocumented
def run(self, **kwargs): (source)
overrides sphinx.transforms.post_transforms.SphinxPostTransform.run
overridden in sphinx.ext.intersphinx.IntersphinxRoleResolver

Main method of post transforms. Subclasses should override this method instead of ``apply()``.

Parameters
**kwargs:AnyUndocumented
def warn_missing_reference(self, refdoc, typ, target, node, domain): (source)

Undocumented

Parameters
refdoc:strUndocumented
typ:strUndocumented
target:strUndocumented
node:pending_xrefUndocumented
domain:Domain|NoneUndocumented
default_priority: int = (source)
overridden in sphinx.ext.intersphinx.IntersphinxRoleResolver

Undocumented