Home       Trees       Index       Help   

epydoc 2.0

Package epydoc :: Package markup :: Module restructuredtext :: Class ParsedRstDocstring
[show private | hide private]
[frames | no frames]

Class ParsedRstDocstring

ParsedDocstring --+
                  |
                 ParsedRstDocstring

An encoded version of a ReStructuredText docstring. The contents of the docstring are encoded in the _document instance variable.
Method Summary
  __init__(self, document)
  __repr__(self)
  concatenate(self, other)
Return a new parsed docstring containing the concatination of this docstring and other.
(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_plaintext(self, docstring_linker, **options)
Translate this docstring to plaintext.
Inherited from ParsedDocstring: __add__, index_terms, to_latex

Instance Variable Summary
docutils.nodes.document _document: A ReStructuredText document, encoding the docstring.

Method Details

__init__(self, document)
(Constructor)

Parameters:
document
           (type=docutils.nodes.document)

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)

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_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)

Instance Variable Details

_document

A ReStructuredText document, encoding the docstring.
Type:
docutils.nodes.document

   Home       Trees       Index       Help   

epydoc 2.0

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