docutils.parsers.rst.directives.tables.ListTable

class documentation

class ListTable(Table): (source)

View In Hierarchy

Implement tables whose data is encoded as a uniform two-level bullet list. For further ideas, see https://docutils.sourceforge.io/docs/dev/rst/alternatives.html#list-driven-tables

Method build_table_from_list Undocumented
Method check_list_content Undocumented
Method run Undocumented
Class Variable option_spec Mapping of option names to validator functions.

Inherited from Table:

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 optional_arguments Number of optional arguments after the required arguments.
Property widths Undocumented

Inherited from Directive (via Table):

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 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 reporter Undocumented
Instance Variable state Undocumented
Instance Variable state_machine Undocumented
def build_table_from_list(self, table_data, col_widths, header_rows, stub_columns): (source)

Undocumented

def check_list_content(self, node): (source)

Undocumented

def run(self): (source)
overrides docutils.parsers.rst.Directive.run

Undocumented

option_spec = (source)
overrides docutils.parsers.rst.directives.tables.Table.option_spec

Mapping of option names to validator functions.