class _EpydocLinker(DocstringLinker):
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. |
Parameters | |
identifier:str | Undocumented |
label:Flattenable | The label to show for the link. |
target | The name of the Python identifier that should be linked to. |
Returns | |
Tag | The link, or just the label if the target was not found. |
Parameters | |
target:str | The name of the Python identifier that should be linked to. |
label:Flattenable | The label to show for the link. |
lineno:int | The line number within the docstring at which the crossreference is located. |
Returns | |
Tag | The link, or just the label if the target was not found. In either case, the returned top-level tag will be <code>. |
Return link for `name` based on intersphinx inventory.
Return None if link is not found.
Parameters | |
name:str | Undocumented |
Returns | |
Optional[ | Undocumented |
Undocumented
Parameters | |
name:str | Undocumented |
candidates:Iterable[ | Undocumented |
lineno:int | Undocumented |
Returns | |
Optional[ | Undocumented |
Parameters | |
identifier:str | The name of the Python identifier that should be linked to. |
Returns | |
Optional[ | The URL of the target, or None if not found. |
Parameters | |
identifier:str | The name of the Python identifier that should be linked to. |
lineno:int | The line number within the docstring at which the crossreference is located. |
Returns | |
Union[ | The referenced object within our system, or the URL of an external target (found via Intersphinx). |
Raises | |
LookupError | If identifier could not be resolved. |