epydoc.markup.epytext.ParsedEpytextDocstring

Package epydoc :: Package markup :: Module epytext :: Class ParsedEpytextDocstring |
[show private | hide private]
[frames | no frames]

## 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.
| `_index_term_key(self, tree)`
| `_index_terms(self, tree, terms)`
| `_to_html(self, tree, linker, indent, seclevel)`
| `_to_latex(self, tree, linker, indent, seclevel, breakany)`
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

### concatenate(self, other) Returns: A new parsed docstring containing the concatination of this docstring and `other`. Raises: `ValueError` - If the two parsed docstrings are incompatible. Overrides: `epydoc.markup.ParsedDocstring.concatenate` (inherited documentation)

### index_terms(self) 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_fields(self, errors=None) 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)

### summary(self) 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)

### to_html(self, docstring_linker, **options) 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. Returns: An HTML fragment that encodes this docstring. (type=`string`) Overrides: `epydoc.markup.ParsedDocstring.to_html` (inherited documentation)

### to_latex(self, docstring_linker, **options) 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. Returns: A LaTeX fragment that encodes this docstring. (type=`string`) Overrides: `epydoc.markup.ParsedDocstring.to_latex` (inherited documentation)

### to_plaintext(self, docstring_linker, **options) 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

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

    ### SYMBOL_TO_LATEX 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 | http://epydoc.sf.net