epydoc.markup.epytext.ParsedEpytextDocstring

Package epydoc :: Package markup :: Module epytext :: Class ParsedEpytextDocstring

[show private | hide private]

Class ParsedEpytextDocstring

ParsedDocstring --+
                  |
                 ParsedEpytextDocstring

Method Summary
	`__init__(self, dom_tree)`
	`concatenate(self, other)` Return a new parsed docstring containing the concatination of this docstring and `other`.
`list` of `ParsedDocstring`	`index_terms(self)` Return the list of index terms that are defined in this docstring.
`(ParsedDocstring, list of Field)`	`split_fields(self, errors)` Split this docstring into its body and its fields.
`ParsedDocstring`	`summary(self)` Return a short summary of this docstring.
`string`	`to_html(self, docstring_linker, **options)` Translate this docstring to HTML.
`string`	`to_latex(self, docstring_linker, **options)` Translate this docstring to LaTeX.
`string`	`to_plaintext(self, docstring_linker, **options)` Translate this docstring to plaintext.
Inherited from `ParsedDocstring`: `__add__`

Class Variable Summary
`dict`	`SYMBOL_TO_HTML` = `{'xi': 'xi', '>=': 'ge', 'lArr': 'lArr'...`
`dict`	`SYMBOL_TO_LATEX` = `{'xi': '\\(\\xi\\)', '>=': '\\(\\ge\\)...`

Method Details

Returns:: A new parsed docstring containing the concatination of this docstring and other.

Overrides:: epydoc.markup.ParsedDocstring.concatenate (inherited documentation)

Returns:: The list of index terms that are defined in this docstring. Each of these items will be added to the index page of the documentation.
(type=list of ParsedDocstring)

Overrides:: epydoc.markup.ParsedDocstring.index_terms (inherited documentation)

Split this docstring into its body and its fields.

Parameters:: errors - A list where any errors generated during splitting will be stored. If no list is specified, then errors will be ignored.
(type=list of ParseError)

Returns:: A tuple (body, fields), where body is the main body of this docstring, and fields is a list of its fields.
(type=(ParsedDocstring, list of Field))

Overrides:: epydoc.markup.ParsedDocstring.split_fields (inherited documentation)

Returns:: A short summary of this docstring. Typically, the summary consists of the first sentence of the docstring.
(type=ParsedDocstring)

Overrides:: epydoc.markup.ParsedDocstring.summary (inherited documentation)

Translate this docstring to HTML.

Parameters:: docstring_linker - An HTML translator for crossreference links into and out of the docstring.
(type=DocstringLinker); options - Any extra options for the output. Unknown options are ignored.

Overrides:: epydoc.markup.ParsedDocstring.to_html (inherited documentation)

Translate this docstring to LaTeX.

Parameters:: docstring_linker - A LaTeX translator for crossreference links into and out of the docstring.
(type=DocstringLinker); options - Any extra options for the output. Unknown options are ignored.

Overrides:: epydoc.markup.ParsedDocstring.to_latex (inherited documentation)

Translate this docstring to plaintext.

Parameters:: docstring_linker - A plaintext translator for crossreference links into and out of the docstring.
(type=DocstringLinker); options - Any extra options for the output. Unknown options are ignored.

Returns:: A plaintext fragment that encodes this docstring.
(type=string)

Overrides:: epydoc.markup.ParsedDocstring.to_plaintext (inherited documentation)

Class Variable Details

Type:: dict
Value:: {'>=': 'ge', 'Chi': 'Chi', 'asymp': 'asymp', 'ge': 'ge', 'lArr': 'lArr', 'omega': 'omega', 'otimes': 'otimes', 'sube': 'sube', ...

Type:: dict
Value:: {'>=': '\\(\\ge\\)', 'Chi': '\\(\\chi\\)', 'asymp': '\\(\\approx\\)', 'ge': '\\(\\ge\\)', 'lArr': '\\(\\Leftarrow\\)', 'omega': '\\(\\omega\\)', 'otimes': '\\(\\otimes\\)', 'sube': '\\(\\subseteq\\)', ...

Generated by Epydoc 2.1 on Sat Mar 20 17:46:18 2004