Class _HTMLDocstringLinker

source code

Instance Methods

[hide private]

__init__(self, htmlwriter, container)

source code
call graph

string

translate_indexterm(self, indexterm)
Translate an index term to the appropriate output format.

source code
call graph

string

translate_identifier_xref(self, identifier, label=True)
Translate a crossreference link to a Python identifier to the appropriate output format.

source code
call graph

url_for(self, identifier)

source code
call graph

_failed_xref(self, identifier)
Add an identifier to the htmlwriter's failed crossreference list.

source code
call graph

Method Details

[hide private]

translate_indexterm(self, indexterm)

source code
call graph

Translate an index term to the appropriate output format. The output will typically include a crossreference anchor.

Returns: string: The translated index term.
Overrides: markup.DocstringLinker.translate_indexterm: (inherited documentation)

translate_identifier_xref(self, identifier, label=True)

source code
call graph

Translate a crossreference link to a Python identifier to the appropriate output format. The output will typically include a reference or pointer to the crossreference target.

Returns: string: The translated crossreference link.
Overrides: markup.DocstringLinker.translate_identifier_xref: (inherited documentation)