The following directive can be used in any restructured text file:
[qualified class name]¶
Create a table of contents (TOC) for the given Python class.
The TOC contains a link to each method defined in the given class. By default, the links are organized into four groups: “Public Attributes”, “Public Methods”, “Private Attributes”, and “Private Methods”. Public attributes/methods are those with names that either don’t begin with an underscore or begin and end with two underscores (i.e. “dunder methods”). Every other attribute/method is private. It’s easy to define custom sections; see Advanced Usage for more details.
In addition to attributes directly defined in the given class, the TOC will also include links to inherited attributes. These links are grouped by the class they are inherited from, and are collapsed by default to keep the TOC succinct.
[qualified class name]argument is optional if this directive occurs within an
py:classdirective (in which case the class name can be inferred from the context). If this argument is provided, it must be the full name of the class, in the same manner expected by
A comma-separated list of sections to include in the class TOC. If specified, this supercedes the
A comma-separated list of sections to exclude from the class TOC. This can be used in conjunction with the
:sections:option above. No sections are excluded by default.
The “class TOCs” created by this directive are not related to the TOCs defined by
toctree. The term TOC is just used to mean an organized list of links to more detailed documentation.