PyFoam.Basics.RestructuredTextHelper module¶
Helps formatting output for restructured text
-
class
PyFoam.Basics.RestructuredTextHelper.
LabledReSTTable
[source]¶ Bases:
PyFoam.Basics.RestructuredTextHelper.ReSTTable
A ReSTTable that has rownames in the first column and column-names in the first row
-
class
PyFoam.Basics.RestructuredTextHelper.
ReSTTable
[source]¶ Bases:
object
Class that administrates a two-dimensional table and prints it as a restructured text-table when asked
-
class
PyFoam.Basics.RestructuredTextHelper.
RestructuredTextHelper
(defaultHeading=2)[source]¶ Bases:
object
Helper class that formats stuff for restructured text
-
LevelChapter
= 1¶
-
LevelParagraph
= 5¶
-
LevelPart
= 0¶
-
LevelSection
= 2¶
-
LevelSubSection
= 3¶
-
LevelSubSubSection
= 4¶
-
buildHeading
(*text, **keywords)[source]¶ General method to build a heading :param text: list of items that build the heading text :param level: The level of the heading
-
code
(code, language='python')[source]¶ @param code: string to be typeset as a program code @param language: programming language to be used
-