sphinx.writers.latex.Table

class documentation

class Table:

View In Hierarchy

A table data
Method __init__ Undocumented
Method add​_cell Adds a new cell to a table.
Method cell Returns a cell object (i.e. rectangular area) containing given position.
Method get​_colspec Returns a column spec of table.
Method get​_table​_type Returns the LaTeX environment name for the table.
Method is​_longtable True if and only if table uses longtable environment.
Instance Variable align Undocumented
Instance Variable body Undocumented
Instance Variable caption Undocumented
Instance Variable cell​_id Undocumented
Instance Variable cells Undocumented
Instance Variable classes Undocumented
Instance Variable col Undocumented
Instance Variable colcount Undocumented
Instance Variable colspec Undocumented
Instance Variable colwidths Undocumented
Instance Variable has​_oldproblematic Undocumented
Instance Variable has​_problematic Undocumented
Instance Variable has​_verbatim Undocumented
Instance Variable header Undocumented
Instance Variable row Undocumented
Instance Variable stubs Undocumented
def __init__(self, node):

Undocumented

Parameters
node:ElementUndocumented
def add_cell(self, height, width):

Adds a new cell to a table.

It will be located at current position: (self.row, self.col).

Parameters
height:intUndocumented
width:intUndocumented
def cell(self, row=None, col=None):

Returns a cell object (i.e. rectangular area) containing given position.

If no option arguments: row or col are given, the current position; self.row and self.col are used to get a cell object by default.

Parameters
row:intUndocumented
col:intUndocumented
Returns
TableCellUndocumented
def get_colspec(self):

Returns a column spec of table.

This is what LaTeX calls the 'preamble argument' of the used table environment.

Note

the \X and T column type specifiers are defined in sphinx.sty.

Returns
strUndocumented
def get_table_type(self):

Returns the LaTeX environment name for the table.

The class currently supports:

  • longtable
  • tabular
  • tabulary
Returns
strUndocumented
def is_longtable(self):
True if and only if table uses longtable environment.
Returns
boolUndocumented
align =

Undocumented

body: List[str] =

Undocumented

caption: List[str] =

Undocumented

cell_id: int =

Undocumented

cells: Dict[Tuple[int, int], int] =

Undocumented

classes: List[str] =

Undocumented

col: int =

Undocumented

colcount: int =

Undocumented

colspec: str =

Undocumented

colwidths: List[int] =

Undocumented

has_oldproblematic: bool =

Undocumented

has_problematic: bool =

Undocumented

has_verbatim: bool =

Undocumented

header: List[str] =

Undocumented

row: int =

Undocumented

stubs: List[int] =

Undocumented