pydoctor.linker

module documentation
(source)

This module provides implementations of epydoc's DocstringLinker class.

Class NotFoundLinker A DocstringLinker implementation that cannot find any links.
Function intersphinx_link Create a intersphinx link.
Function taglink Create a link to an object that exists in the system.
Class _EpydocLinker This linker implements the xref lookup logic.
def intersphinx_link(label: Flattenable, url: str) -> Tag: (source)

Create a intersphinx link.

It's special because it uses the 'intersphinx-link' CSS class.

def taglink(o: model.Documentable, page_url: str, label: Flattenable | None = None) -> Tag: (source)

Create a link to an object that exists in the system.

Parameters
o:model.DocumentableThe object to link to
page_url:strThe URL of the current page, pass empty string to always generate full urls that includes the filename.
label:Flattenable | NoneThe label to use for the link
Returns
TagUndocumented