sphinx.ext.autosummary.AutoLink

class documentation

class AutoLink(SphinxRole): (source)

View In Hierarchy

Smart linking role. Expands to ':obj:`text`' if `text` is an object that can be imported; otherwise expands to '*text*'.

Method run Undocumented

Inherited from SphinxRole:

Method __call__ Undocumented
Method get_location Get current location info for logging.
Method get_source_info Undocumented
Method set_source_info Undocumented
Instance Variable content Undocumented
Instance Variable inliner Undocumented
Instance Variable lineno Undocumented
Instance Variable name Undocumented
Instance Variable options Undocumented
Instance Variable rawtext Undocumented
Instance Variable text Undocumented
Property config Reference to the :class:`.Config` object.
Property env Reference to the :class:`.BuildEnvironment` object.
def run(self): (source)
overrides sphinx.util.docutils.SphinxRole.run

Undocumented

Returns
tuple[list[Node], list[system_message]]Undocumented