docutils.parsers.rst.directives.parts.Contents

class documentation

class Contents(Directive):

View In Hierarchy

Table of contents.

The table of contents is generated in two passes: initial parse and transform. During the initial parse, a 'pending' element is generated which acts as a placeholder, storing the TOC title and any options internally. At a later stage in the processing, the 'pending' element is replaced by a 'topic' element, a title and the table of contents proper.

Method backlinks Undocumented
Method run Undocumented
Class Variable backlinks​_values Undocumented
Class Variable final​_argument​_whitespace May the final argument contain whitespace?
Class Variable option​_spec Mapping of option names to validator functions.
Class Variable optional​_arguments Number of optional arguments after the required arguments.

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 severe Undocumented
Method warning Undocumented
Class Variable has​_content May the directive have content?
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 backlinks(arg):

Undocumented

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

Undocumented

backlinks_values: tuple[str, ...] =

Undocumented

final_argument_whitespace: bool =
overrides docutils.parsers.rst.Directive.final_argument_whitespace
May the final argument contain whitespace?
option_spec =
overrides docutils.parsers.rst.Directive.option_spec
Mapping of option names to validator functions.
optional_arguments: int =
overrides docutils.parsers.rst.Directive.optional_arguments
Number of optional arguments after the required arguments.