class _AnnotationLinker(DocstringLinker): (source)
Constructor: _AnnotationLinker(obj)
Specialized linker to resolve annotations attached to the given Documentable
.
Links will be created in the context of obj but generated with the obj.module's linker when possible.
Method | __init__ |
Undocumented |
Method | link |
Format a link to a Python identifier. This will resolve the identifier like Python itself would. |
Method | link |
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 | switch |
Switch the context of the linker, keeping the same underlying lookup rules. |
Method | warn |
Undocumented |
Property | obj |
Undocumented |
Instance Variable | _module |
Undocumented |
Instance Variable | _obj |
Undocumented |
Instance Variable | _scope |
Undocumented |
Instance Variable | _scope |
Undocumented |
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: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>. |
def switch_context(self, ob:
model.Documentable | None
) -> Iterator[ None]
:
(source)
¶
Switch the context of the linker, keeping the same underlying lookup rules.
Useful to resolve links with the right Documentable
context but create correct - absolute or relative - links to be clicked on from another page rather than the initial page of the context. "Cannot find link target" errors will be reported relatively to the new context object.
Pass None to always generate full URLs (for summaries for example), in this case error will NOT be reported at all.