pydoctor.linker

module documentation

(source)

This module provides implementations of epydoc's DocstringLinker class.

Function	`taglink`	Create a link to an object that exists in the system.
Class	`_CachedEpydocLinker`	This linker implements smart caching functionalities on top of public methods defined in `_EpydocLinker`.
Class	`_EpydocLinker`	This linker implements the xref lookup logic.

def taglink(o, page_url, label=None, same_page_optimization=True): (source) ¶

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

Parameters
o:`model.Documentable`	The object to link to
page_url:`str`	The URL of the current page
label:`Optional[Flattenable]`	The label to use for the link
same_page_optimization:`bool`	Whether to create a link with the anchor only when page_url matches the object's URL.
Returns
`Tag`	Undocumented