HappyDoc Generated Documentation HappyDoc3-r3_1/happydoclib/docstring/StructuredText/ST.py

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

Functions   
  findlevel 
findlevel ( levels,  indent )

remove all level information of levels with a greater level of indentation. Then return which level should insert this paragraph

  indention 
indention ( str,  front=re.compile( "^\s+" ).match )

Find the number of leading spaces. If none, return 0.

  insert 
insert (
        struct,
        top,
        level,
        )

find what will be the parant paragraph of a sentence and return that paragraph's sub-paragraphs. The new paragraph will be appended to those sub-paragraphs

  StructuredText 
StructuredText ( paragraphs,  delimiter=re.compile( para_delim ) )

StructuredText accepts paragraphs, which is a list of lines to be parsed. StructuredText creates a structure which mimics the structure of the paragraphs. Structure => [paragraph,[sub-paragraphs]]

Golly, the capitalization of this function always makes me think it's a class

  display2 
display2 ( struct )

runs through the structure and prints out the paragraphs. If the insertion works correctly, display's results should mimic the orignal paragraphs.

  display 
display ( struct )

runs through the structure and prints out the paragraphs. If the insertion works correctly, display's results should mimic the orignal paragraphs.

Classes   

StructuredTextDocument

A StructuredTextDocument holds StructuredTextParagraphs

StructuredTextParagraph


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