sphinx.writers.text.Table

Represents a table, handling cells that can span multiple lines or rows, like:

+-----------+-----+
| AAA       | BBB |
+-----+-----+     |
|     | XXX |     |
|     +-----+-----+
| DDD | CCC       |
+-----+-----------+

This class can be used in two ways, either:

• With absolute positions: call table[line, col] = Cell(...), this overwrites any existing cell(s) at these positions.
• With relative positions: call the add_row() and add_cell(Cell(...)) as needed.

Cells spanning multiple rows or multiple columns (having a colspan or rowspan greater than one) are automatically referenced by all the table cells they cover. This is a useful representation as we can simply check if self[x, y] is self[x, y+1] to recognize a rowspan.

Colwidth is not automatically computed, it has to be given, either at construction time, or during the table construction.

Example usage:

table = Table([6, 6])
table.add_cell(Cell("foo"))
table.add_cell(Cell("bar"))
table.set_separator()
table.add_row()
table.add_cell(Cell("FOO"))
table.add_cell(Cell("BAR"))
print(table)
+--------+--------+
| foo    | bar    |
|========|========|
| FOO    | BAR    |
+--------+--------+