Function
docutils.parsers.rst.directives.parts.contents

Signature

contents(name, arguments, options, content, lineno, content_offset, block_text, state, state_machine)

Documentation String

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.

Attributes