ClassType _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=None)
Translate a crossreference link to a Python identifier to the appropriate output format.

source code
call graph

url_for(self, identifier)
Given an identifier, return a URL pointing at that 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.

Parameters:

indexterm - The index term to translate.

Returns: string

The translated index term.

Overrides: markup.DocstringLinker.translate_indexterm

(inherited documentation)

translate_identifier_xref(self, identifier, label=None)

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.

Parameters:

identifier - The name of the Python identifier that should be linked to.
label - The label that should be used for the identifier, if it's different from the name of the identifier. This should be expressed in the target markup language -- e.g. for latex, "_"s should be escaped.

Returns: string

The translated crossreference link.

Overrides: markup.DocstringLinker.translate_identifier_xref

(inherited documentation)

url_for(self, identifier)

source code
call graph

Given an identifier, return a URL pointing at that identifier. This is used to create hyperlinks in dotgraphs. This method is *optional* -- i.e., it may raise NotImplementedError

Overrides: markup.DocstringLinker.url_for: (inherited documentation)