Package PyFoam :: Package Basics :: Module RestructuredTextHelper :: Class RestructuredTextHelper
[hide private]
[frames] | no frames]

Class RestructuredTextHelper

source code


Helper class that formats stuff for restructured text

Instance Methods [hide private]
 
__init__(self, defaultHeading=2)
x.__init__(...) initializes x; see help(type(x)) for signature
source code
 
buildHeading(self, *text, **keywords)
General method to build a heading
source code
 
heading(self, *text)
Build a heading on the default level
source code
 
table(self)
Creates a new ReSTTable-object
source code

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__, __sizeof__, __str__, __subclasshook__

Class Variables [hide private]
  LevelChapter = 1
  LevelParagraph = 5
  LevelPart = 0
  LevelSection = 2
  LevelSubSection = 3
  LevelSubSubSection = 4
Properties [hide private]

Inherited from object: __class__

Method Details [hide private]

__init__(self, defaultHeading=2)
(Constructor)

source code 

x.__init__(...) initializes x; see help(type(x)) for signature

Overrides: object.__init__
(inherited documentation)

buildHeading(self, *text, **keywords)

source code 

General method to build a heading

Parameters:
  • text - list of items that build the heading text
  • level - The level of the heading