linuxdoc.rstFlatTable module

flat-table

Implementation of the flat-table reST-directive. User documentation see flat-table

class linuxdoc.rstFlatTable.FlatTable(name, arguments, options, content, lineno, content_offset, block_text, state, state_machine)

Bases: Table

FlatTable (flat-table) directive

option_spec = {'align': <function align>, 'class': <function class_option>, 'fill-cells': <function flag>, 'header-rows': <function nonnegative_int>, 'name': <function unchanged>, 'stub-columns': <function nonnegative_int>, 'width': <function length_or_percentage_or_unitless>, 'widths': <function value_or.<locals>.auto_or_other>}

Mapping of option names to validator functions.

run()

class linuxdoc.rstFlatTable.ListTableBuilder(directive)

Bases: object

Builds a table from a double-stage list

buildTableNode()

buildTableRowNode(row_data, classes=None)

parseCellItem(cellItem)

parseFlatTableNode(node)

parses the node from a FlatTable directive’s body

parseRowItem(rowItem, rowNum)

pprint()

raiseError(msg)

roundOffTableDefinition()

Round off the table definition.

This method rounds off the table definition in rows.

• This method inserts the needed None values for the missing cells arising from spanning cells over rows and/or columns.

• recount the max_cols

• Autospan or fill (option fill-cells) missing cells on the right side of the table-row

linuxdoc.rstFlatTable.c_span(name, rawtext, text, lineno, inliner, options=None, content=None)

class linuxdoc.rstFlatTable.colSpan(rawsource='', *children, **attributes)

Bases: General, Element

linuxdoc.rstFlatTable.r_span(name, rawtext, text, lineno, inliner, options=None, content=None)

class linuxdoc.rstFlatTable.rowSpan(rawsource='', *children, **attributes)

Bases: General, Element

linuxdoc.rstFlatTable.setup(app)