class documentation
class RecordingAnnotationLinker(DocstringLinker): (source)
A DocstringLinker implementation that cannot find any links, but does record which identifiers it was asked to link.
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 | resolve |
Resolve a Python identifier. This will resolve the identifier like Python itself would. |
Instance Variable | requests |
Undocumented |
Inherited from DocstringLinker
:
Method | disable |
By default, when linkng to an object on the same page, the linker will generate an URL that links to the anchor only, this will avoid reloading the page needlessly. But sometimes we're using a linker to present the content on another page... |
Format a link to a Python identifier. This will resolve the identifier like Python itself would.
Parameters | |
target:str | The name of the Python identifier that should be linked to. |
label:Flattenable | The label to show for the link. |
Returns | |
Tag | The link, or just the label if the target was not found. |
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>. |