docutils.parsers.rst.directives.tables.Table

class documentation

class Table(Directive): (source)

Known subclasses: docutils.parsers.rst.directives.tables.CSVTable, docutils.parsers.rst.directives.tables.ListTable, docutils.parsers.rst.directives.tables.RSTTable

View In Hierarchy

Generic table base class.
Method check​_table​_dimensions Undocumented
Method extend​_short​_rows​_with​_empty​_cells Undocumented
Method get​_column​_widths Undocumented
Method make​_title Undocumented
Method process​_header​_option Undocumented
Method set​_table​_width Undocumented
Class Variable final​_argument​_whitespace May the final argument contain whitespace?
Class Variable has​_content May the directive have content?
Class Variable option​_spec Mapping of option names to validator functions.
Class Variable optional​_arguments Number of optional arguments after the required arguments.
Property widths Undocumented

Inherited from Directive:

Method __init__ Undocumented
Method add​_name Append self.options['name'] to node['names'] if it exists.
Method assert​_has​_content Throw an ERROR-level DirectiveError if the directive doesn't have contents.
Method debug Undocumented
Method directive​_error Return a DirectiveError suitable for being thrown as an exception.
Method error Undocumented
Method info Undocumented
Method run Undocumented
Method severe Undocumented
Method warning Undocumented
Class Variable required​_arguments Number of required directive arguments.
Instance Variable arguments Undocumented
Instance Variable block​_text Undocumented
Instance Variable content Undocumented
Instance Variable content​_offset Undocumented
Instance Variable lineno Undocumented
Instance Variable name Undocumented
Instance Variable options Undocumented
Instance Variable state Undocumented
Instance Variable state​_machine Undocumented
def check_table_dimensions(self, rows, header_rows, stub_columns): (source)

Undocumented

def extend_short_rows_with_empty_cells(self, columns, parts): (source)

Undocumented

def get_column_widths(self, max_cols): (source)

Undocumented

def make_title(self): (source)

Undocumented

def process_header_option(self): (source)

Undocumented

def set_table_width(self, table_node): (source)

Undocumented

final_argument_whitespace: bool = (source)
overrides docutils.parsers.rst.Directive.final_argument_whitespace
May the final argument contain whitespace?
has_content: bool = (source)
overrides docutils.parsers.rst.Directive.has_content
May the directive have content?
option_spec = (source)
overrides docutils.parsers.rst.Directive.option_spec
overridden in docutils.parsers.rst.directives.tables.CSVTable, docutils.parsers.rst.directives.tables.ListTable
Mapping of option names to validator functions.
optional_arguments: int = (source)
overrides docutils.parsers.rst.Directive.optional_arguments
Number of optional arguments after the required arguments.
@property
widths = (source)

Undocumented