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)[source]

Bases: docutils.parsers.rst.directives.tables.Table

FlatTable (flat-table) directive

option_spec = {'class': <function class_option>, 'fill-cells': <function flag>, 'header-rows': <function nonnegative_int>, 'name': <function unchanged>, 'stub-columns': <function nonnegative_int>, 'widths': <function positive_int_list>}

Mapping of option names to validator functions.

run()[source]
class linuxdoc.rstFlatTable.ListTableBuilder(directive)[source]

Bases: object

Builds a table from a double-stage list

buildTableNode()[source]
buildTableRowNode(row_data, classes=None)[source]
parseCellItem(cellItem)[source]
parseFlatTableNode(node)[source]

parses the node from a FlatTable directive’s body

parseRowItem(rowItem, rowNum)[source]
pprint()[source]
raiseError(msg)[source]
roundOffTableDefinition()[source]

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)[source]
class linuxdoc.rstFlatTable.colSpan(rawsource='', *children, **attributes)[source]

Bases: docutils.nodes.General, docutils.nodes.Element

linuxdoc.rstFlatTable.r_span(name, rawtext, text, lineno, inliner, options=None, content=None)[source]
class linuxdoc.rstFlatTable.rowSpan(rawsource='', *children, **attributes)[source]

Bases: docutils.nodes.General, docutils.nodes.Element

linuxdoc.rstFlatTable.setup(app)[source]