Home       Trees       Index       Help   

epydoc 3.0alpha2

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

Class ParsedRstDocstring
source code

An encoded version of a ReStructuredText docstring. The contents of the docstring are encoded in the _document instance variable.

Instance Methods [hide private]
  __init__(self, document)
(ParsedDocstring, list of Field) split_fields(self, errors=None)
Split this docstring into its body and its fields.
ParsedDocstring summary(self)
string to_html(self, docstring_linker, directory=None, docindex=None, context=None, **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.
  __repr__(self)

Inherited from ParsedDocstring: __add__, concatenate, index_terms


Instance Variables [hide private]
_document A ReStructuredText document, encoding the docstring.

Method Details [hide private]

__init__(self, document)
(Constructor)

source code 
call graph 

split_fields(self, errors=None)

source code 
call graph 
Split this docstring into its body and its fields.
Returns: (ParsedDocstring, list of Field)
A tuple (body, fields), where body is the main body of this docstring, and fields is a list of its fields.
Overrides: ParsedDocstring.split_fields
(inherited documentation)

summary(self)

source code 
call graph 
Returns: ParsedDocstring
A short summary of this docstring. Typically, the summary consists of the first sentence of the docstring.
Overrides: ParsedDocstring.summary
(inherited documentation)

to_html(self, docstring_linker, directory=None, docindex=None, context=None, **options)

source code 
call graph 
Translate this docstring to HTML.
Returns: string
An HTML fragment that encodes this docstring.
Overrides: ParsedDocstring.to_html
(inherited documentation)

to_latex(self, docstring_linker, **options)

source code 
Translate this docstring to LaTeX.
Returns: string
A LaTeX fragment that encodes this docstring.
Overrides: ParsedDocstring.to_latex
(inherited documentation)

to_plaintext(self, docstring_linker, **options)

source code 
call graph 
Translate this docstring to plaintext.
Returns: string
A plaintext fragment that encodes this docstring.
Overrides: ParsedDocstring.to_plaintext
(inherited documentation)

__repr__(self)
(Representation operator)

source code 

Instance Variable Details [hide private]

_document

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

   Home       Trees       Index       Help   

epydoc 3.0alpha2

Generated by Epydoc 3.0alpha2 on Tue Apr 11 17:37:33 2006 http://epydoc.sf.net