HappyDoc Generated Documentation Class: StructuredText

HappyDoc3-r3_1 / happydoclib / docstring / StructuredText / ClassicStructuredText.py / StructuredText 

Model text as structured collection of paragraphs.

Structure is implied by the indentation level.

This class is intended as a base classes that do actual text output formatting.

Methods   
  __str__ 
__str__ ( self )
  __init__ 
__init__ (
        self,
        aStructuredString,
        level=0,
        paragraph_divider=ts_regex.compile( '\(\r?\n *\)+\r?\n' ),
        )

Convert a structured text string into a structured text object.

Aguments:
aStructuredString
The string to be parsed. level -- The level of top level headings to be created.

This document was automatically generated Tue Dec 5 08:31:22 2006 by HappyDoc version 3.1