class documentation

class _EpydocLinker(DocstringLinker):

View In Hierarchy

Undocumented

Method __init__ Undocumented
Method link​_to Format a link to a Python identifier. This will resolve the identifier like Python itself would.
Method link​_xref Format a cross-reference link to a Python identifier. This will resolve the identifier to any reasonable target, even if it has to look in places where Python itself would not.
Method look​_for​_intersphinx Return link for `name` based on intersphinx inventory.
Method look​_for​_name Undocumented
Method resolve​_identifier Resolve a Python identifier. This will resolve the identifier like Python itself would.
Instance Variable obj Undocumented
Method ​_resolve​_identifier​_xref Resolve a crossreference link to a Python identifier. This will resolve the identifier to any reasonable target, even if it has to look in places where Python itself would not.
def __init__(self, obj):

Undocumented

Parameters
obj:model.DocumentableUndocumented
def link_to(self, identifier, label):
Format a link to a Python identifier. This will resolve the identifier like Python itself would.
Parameters
identifier:strUndocumented
label:FlattenableThe label to show for the link.
targetThe name of the Python identifier that should be linked to.
Returns
TagThe link, or just the label if the target was not found.
def link_xref(self, target, label, lineno):
Format a cross-reference link to a Python identifier. This will resolve the identifier to any reasonable target, even if it has to look in places where Python itself would not.
Parameters
target:strThe name of the Python identifier that should be linked to.
label:FlattenableThe label to show for the link.
lineno:intThe line number within the docstring at which the crossreference is located.
Returns
TagThe link, or just the label if the target was not found. In either case, the returned top-level tag will be <code>.
def look_for_intersphinx(self, name):

Return link for `name` based on intersphinx inventory.

Return None if link is not found.

Parameters
name:strUndocumented
Returns
Optional[str]Undocumented
def look_for_name(self, name, candidates, lineno):

Undocumented

Parameters
name:strUndocumented
candidates:Iterable[model.Documentable]Undocumented
lineno:intUndocumented
Returns
Optional[model.Documentable]Undocumented
def resolve_identifier(self, identifier):
Resolve a Python identifier. This will resolve the identifier like Python itself would.
Parameters
identifier:strThe name of the Python identifier that should be linked to.
Returns
Optional[str]The URL of the target, or None if not found.
obj =

Undocumented

def _resolve_identifier_xref(self, identifier, lineno):
Resolve a crossreference link to a Python identifier. This will resolve the identifier to any reasonable target, even if it has to look in places where Python itself would not.
Parameters
identifier:strThe name of the Python identifier that should be linked to.
lineno:intThe line number within the docstring at which the crossreference is located.
Returns
Union[str, model.Documentable]The referenced object within our system, or the URL of an external target (found via Intersphinx).
Raises
LookupErrorIf identifier could not be resolved.