| Home | Trees | Index | Help |  | 
|---|
| Package epydoc :: Package markup :: Module restructuredtext :: Class ParsedRstDocstring | 
 | 
ParsedDocstring --+
                  |
                 ParsedRstDocstring
_document instance variable.
| Method Summary | |
|---|---|
|  | |
| __repr__(self) | |
| Return a new parsed docstring containing the concatination of this docstring and other. | |
| ( | Split this docstring into its body and its fields. | 
| ParsedDocstring | Return a short summary of this docstring. | 
| string | Translate this docstring to HTML. | 
| string | 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)
     | 
| concatenate(self, other)
 | 
| split_fields(self, errors=None)Split this docstring into its body and its fields.
 | 
| summary(self)
 | 
| to_html(self, docstring_linker, **options)Translate this docstring to HTML.
 | 
| to_plaintext(self, docstring_linker, **options)Translate this docstring to plaintext.
 | 
| Instance Variable Details | 
|---|
| _documentA ReStructuredText document, encoding the docstring.
 | 
| Home | Trees | Index | Help |  | 
|---|
| Generated by Epydoc 2.1 on Sat Mar 20 17:46:15 2004 | http://epydoc.sf.net |