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

addItem(column, value, row=None)[source]
addRow(rowName)[source]
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

addLine(val=None, head=False)[source]

Add a line after that row :param val: the row after which to add. If None a line will be added after the current last row

setElement(row, col, value)[source]

Sets a specific element :param row: the row :param col: column :param value: the used value

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

bulletList(data, bullet='-')[source]

Generate a bullet list from the data

code(code, language='python')[source]

@param code: string to be typeset as a program code @param language: programming language to be used

definitionList(data)[source]

Generate a definiton list from the data.

emphasis(*txt)[source]
enumerateList(data, first=1)[source]

Generate an enumerated list from the data. First number can be chosen and determines the format

heading(*text)[source]

Build a heading on the default level

literal(*txt)[source]
strong(*txt)[source]
table(labeled=False)[source]

Creates a new ReSTTable-object