| Home | Trees | Index | Help |  | 
|---|
| Package epydoc :: Package markup :: Module restructuredtext | 
 | 
Epydoc parser for ReStructuredText strings. ReStructuredText is the 
standard markup language used by the Docutils project. parse_docstring() provides the primary 
interface to this module; it returns a ParsedRstDocstring, which supports all of 
the methods defined by ParsedDocstring.
ParsedRstDocstring is basically just a ParsedDocstring wrapper for the 
docutils.nodes.document class.
ParsedRstDocstringsParsedRstDocstrings are created by the 
  parse_document function, using the 
  docutils.core.publish_string() method, with the following 
  helpers:
  _EpydocReader is used to capture all 
      error messages as it parses the docstring.
    _DocumentPseudoWriter is used to 
      extract the document itself, without actually writing any output. 
      The document is saved for further processing. The settings for the 
      writer are copied from 
      docutils.writers.html4css1.Writer, since those 
      settings will be used when we actually write the docstring to 
      html.
    ParsedRstDocstringsParsedRstDocstrings support all of the methods defined 
  by ParsedDocstring; but only the following four methods 
  have non-default behavior:
  to_html() uses an _EpydocHTMLTranslator to translate 
      the ParsedRstDocstring's document into an HTML 
      segment.
    split_fields() uses a _SplitFieldsTranslator to divide the 
      ParsedRstDocstring's document into its main body and 
      its fields. Special handling is done to account for consolidated 
      fields.
    summary() uses a _SummaryExtractor to extract the 
      first sentence from the ParsedRstDocstring's 
      document.
    to_plaintext() uses 
      document.astext() to convert the 
      ParsedRstDocstring's document to plaintext.
    To Do: Add ParsedRstDocstring.to_latex()
| Classes | |
|---|---|
| ParsedRstDocstring | An encoded version of a ReStructuredText docstring. | 
| Function Summary | |
|---|---|
| ParsedDocstring | Parse the given docstring, which is formatted using ReStructuredText; and return a ParsedDocstringrepresentation of its 
contents. | 
| Variable Summary | |
|---|---|
| dict | CONSOLIDATED_FIELDS: A dictionary encoding the set of 'consolidated fields' that can be 
used. | 
| Function Details | 
|---|
| parse_docstring(docstring, errors, **options)Parse the given docstring, which is formatted using ReStructuredText; and return aParsedDocstringrepresentation of its 
  contents.
 | 
| Variable Details | 
|---|
| Home | Trees | Index | Help |  | 
|---|
| Generated by Epydoc 2.1 on Sat Mar 20 17:46:13 2004 | http://epydoc.sf.net |