pydoctor.epydoc.markup.DocstringLinker

class documentation

class DocstringLinker:

Known subclasses: pydoctor.test.NotFoundLinker, pydoctor.test.test_epydoc2stan.RecordingAnnotationLinker, pydoctor.epydoc2stan._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 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 link_to(self, target, label):
overridden in pydoctor.test.NotFoundLinker, pydoctor.test.test_epydoc2stan.RecordingAnnotationLinker, pydoctor.epydoc2stan._EpydocLinker
Format a link to a Python identifier. This will resolve the identifier like Python itself would.
Parameters
target:strThe name of the Python identifier that should be linked to.
label:FlattenableThe label to show for the link.
Returns
TagThe link, or just the label if the target was not found.
def link_xref(self, target, label, lineno):
overridden in pydoctor.test.NotFoundLinker, pydoctor.test.test_epydoc2stan.RecordingAnnotationLinker, pydoctor.epydoc2stan._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:strThe name of the Python identifier that should be linked to.
label:FlattenableThe label to show for the link.
lineno:intThe line number within the docstring at which the crossreference is located.
Returns
TagThe 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):
overridden in pydoctor.test.NotFoundLinker, pydoctor.test.test_epydoc2stan.RecordingAnnotationLinker, pydoctor.epydoc2stan._EpydocLinker
Resolve a Python identifier. This will resolve the identifier like Python itself would.
Parameters
identifier:strThe name of the Python identifier that should be linked to.
Returns
Optional[str]The URL of the target, or None if not found.