epydoc.docwriter.html._HTMLDocstringLinker

Package epydoc :: Package docwriter :: Module html :: Class _HTMLDocstringLinker

Class _HTMLDocstringLinker
source code

Instance Methods	[hide private]

__init__(self, htmlwriter, container)

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

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

url_for(self, identifier)

Method Details	[hide private]

init(self, htmlwriter, container)
(Constructor)

source code

translate_indexterm(self, indexterm)

source code

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=None)

source code

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)

url_for(self, identifier)

source code

Class _HTMLDocstringLinker source code

__init__(self, htmlwriter, container) (Constructor)

translate_indexterm(self, indexterm)

translate_identifier_xref(self, identifier, label=None)

url_for(self, identifier)

Class _HTMLDocstringLinker
source code

init(self, htmlwriter, container)
(Constructor)