pydoctor.epydoc.markup.DocstringLinker

class documentation

class DocstringLinker: (source)

Known subclasses: pydoctor.test.NotFoundLinker, pydoctor.test.test_epydoc2stan.RecordingAnnotationLinker, pydoctor.linker._EpydocLinker

View In Hierarchy

A resolver for crossreference links out of a ParsedDocstring. DocstringLinker is used by ParsedDocstring to look up the target URL for crossreference links.

Method	`disable_same_page_optimazation`	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...
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	`resolve_identifier`	Resolve a Python identifier. This will resolve the identifier like Python itself would.

def disable_same_page_optimazation(self): (source) ¶

overridden in pydoctor.linker._EpydocLinker

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. This context manager will make the linker always generate full URLs.

Returns
`ContextManager[None]`	Undocumented

def link_to(self, target, label): (source) ¶

overridden in pydoctor.test.NotFoundLinker, pydoctor.test.test_epydoc2stan.RecordingAnnotationLinker, pydoctor.linker._EpydocLinker

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.

def link_xref(self, target, label, lineno): (source) ¶

overridden in pydoctor.test.NotFoundLinker, pydoctor.test.test_epydoc2stan.RecordingAnnotationLinker, pydoctor.linker._EpydocLinker

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 resolve_identifier(self, identifier): (source) ¶

overridden in pydoctor.test.NotFoundLinker, pydoctor.test.test_epydoc2stan.RecordingAnnotationLinker, pydoctor.linker._EpydocLinker

Resolve a Python identifier. This will resolve the identifier like Python itself would.

Parameters
identifier:`str`	The name of the Python identifier that should be linked to.
Returns
`Optional[str]`	The URL of the target, or `None` if not found.