docutils.parsers.rst.directives.parts.Contents Class Reference

Inheritance diagram for docutils.parsers.rst.directives.parts.Contents:

Collaboration diagram for docutils.parsers.rst.directives.parts.Contents:

Public Member Functions
	backlinks (arg)
	run (self)
Public Member Functions inherited from docutils.parsers.rst.Directive
	__init__ (self, name, arguments, options, content, lineno, content_offset, block_text, state, state_machine)
	directive_error (self, level, message)
	debug (self, message)
	info (self, message)
	warning (self, message)
	error (self, message)
	severe (self, message)
	assert_has_content (self)
	add_name (self, node)

Public Attributes
	name
	lineno
	options
Public Attributes inherited from docutils.parsers.rst.Directive
	name
	arguments
	options
	content
	lineno
	content_offset
	block_text
	state
	state_machine
	reporter

Static Public Attributes
tuple	backlinks_values = ('top', 'entry', 'none')
int	optional_arguments = 1
bool	final_argument_whitespace = True
dict	option_spec
Static Public Attributes inherited from docutils.parsers.rst.Directive
int	required_arguments = 0
int	optional_arguments = 0
bool	final_argument_whitespace = False
	option_spec = None
bool	has_content = False

Detailed Description

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.

Member Function Documentation

run()

docutils.parsers.rst.directives.parts.Contents.run

(

self

)

Reimplemented from docutils.parsers.rst.Directive.

Member Data Documentation

option_spec

dict docutils.parsers.rst.directives.parts.Contents.option_spec

static

Initial value:

=  {'depth': directives.nonnegative_int,
                   'local': directives.flag,
                   'backlinks': backlinks,
                   'class': directives.class_option}

---

The documentation for this class was generated from the following file:

• docs/help/help-venv/lib/python3.12/site-packages/docutils/parsers/rst/directives/parts.py