pydoctor.test.NotFoundLinker

class documentation

class NotFoundLinker(DocstringLinker): (source)

A DocstringLinker implementation that cannot find any links.

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.

Inherited from DocstringLinker:

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...

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

overrides pydoctor.epydoc.markup.DocstringLinker.link_to

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) ¶

overrides pydoctor.epydoc.markup.DocstringLinker.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.

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) ¶

overrides pydoctor.epydoc.markup.DocstringLinker.resolve_identifier

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.