epydoc.markup.DocstringLinker

Package epydoc :: Package markup :: Class DocstringLinker |
[show private | hide private]
[frames | no frames]

## Class DocstringLinker

A translator for crossreference links into and out of a `ParsedDocstring`. `DocstringLinker` is used by `ParsedDocstring` to convert these crossreference links into appropriate output formats. For example, `DocstringLinker.to_html` expects a `DocstringLinker` that converts crossreference links to HTML.

Method Summary
`string` | ``translate_identifier_xref`(self, identifier, label)` Translate a crossreference link to a Python identifier to the appropriate output format.
`string` | ``translate_indexterm`(self, indexterm)` Translate an index term to the appropriate output format.

Method Details

### translate_identifier_xref(self, identifier, label=None) 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. (type=`string`) `label` - The label that should be used for the identifier, if it's different from the name of the identifier. (type=`string` or `None`) Returns: The translated crossreference link. (type=`string`)

### translate_indexterm(self, indexterm) Translate an index term to the appropriate output format. The output will typically include a crossreference anchor. Parameters: `indexterm` - The index term to translate. (type=`ParsedDocstring`) Returns: The translated index term. (type=`string`)

Generated by Epydoc 2.1 on Sat Mar 20 17:46:17 2004 | http://epydoc.sf.net