sphinx.transforms.post_transforms.ReferencesResolver

class documentation

class ReferencesResolver(SphinxPostTransform):

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 .Sphinx object.
Property config Reference to the .Config object.
Property env Reference to the .BuildEnvironment object.
def find_pending_xref_condition(self, node, conditions):

Undocumented

Parameters
node:pending_xrefUndocumented
conditions:Sequence[str]Undocumented
Returns
Optional[List[Node]]Undocumented
def resolve_anyref(self, refdoc, node, contnode):
Resolve reference generated by the "any" role.
Parameters
refdoc:strUndocumented
node:pending_xrefUndocumented
contnode:ElementUndocumented
Returns
ElementUndocumented
def run(self, **kwargs):
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):

Undocumented

Parameters
refdoc:strUndocumented
typ:strUndocumented
target:strUndocumented
node:pending_xrefUndocumented
domain:Optional[Domain]Undocumented
default_priority: int =
overridden in sphinx.ext.intersphinx.IntersphinxRoleResolver

Undocumented