autoclasstoc

What it is and what it does

autoclasstoc is a Sphinx extension that adds a custom reStructuredText directive to generate a table of contents for Python classes. It solves the navigation problem that arises when using Sphinx's autodoc plugin: while autodoc fully documents every class member, it presents them sequentially without a summary, making it hard for users to understand what a class does or find specific methods. autoclasstoc inserts a collapsible TOC that groups methods into user-defined sections (e.g., public/private, by decorator, by prefix) and collapses inherited methods, so the documentation remains complete while staying navigable.

The package depends on Sphinx, docutils, and more_itertools. It is designed to integrate seamlessly with existing autodoc and autogen workflows. Maintenance is dormant and the license is undeclared, creating uncertainty about both long-term support and legal terms.

Use it for:

• Documenting large classes with many methods where a flat list is hard to navigate.
• Organizing class methods by category (public, private, special, inherited) in auto-generated docs.
• Collapsing inherited methods to highlight a class's own functionality while keeping full documentation.
• Integrating custom section logic into Sphinx autodoc workflows without manual TOC maintenance.
• Improving user experience in API documentation for complex Python libraries.

Worth the install?

AI-flagged interpretation of the facts on this page — verify before relying

Generates a structured table of contents for auto-documented Python classes in Sphinx, organizing class members into meaningful sections while collapsing inherited methods to improve navigation.

Yes, if you are using Sphinx to document complex Python classes and want better navigation without manual TOC maintenance. The low install friction and lack of security vulnerabilities make it safe to try. However, the unclear license and dormant maintenance mean you should verify license compatibility upfront and be prepared to maintain a fork if critical bugs emerge. Not recommended for projects with strict license compliance requirements.

Install

autoclasstoc on PyPI

pip install autoclasstoc

uv add autoclasstoc

poetry add autoclasstoc

Installing autoclasstoc

Before you install

Low install friction with a pure-Python wheel. Dormant maintenance status means no recent updates, though the repository remains active and unarchived.

License in practice

License status is unclear—no SPDX identifier or raw license text is available in the package metadata, so you cannot verify licensing terms before use.

Quickstart

pip install autoclasstoc

In conf.py:
extensions = ['autoclasstoc']

In your .rst file:
.. autoclassoc:: mymodule.MyClass

Requires Sphinx and docutils; intended for use within a Sphinx documentation build, not as a standalone library.

Verify before relying

• Exact license terms—the package metadata does not declare a license, so legal compatibility is unknown.
• Whether the package works with current Sphinx versions—no changelog provided to confirm compatibility.
• Section customization options and API surface—the description mentions flexibility but does not detail configuration.

Package facts

Evidence: autoclasstoc-1.7.0-py3-none-any.whl

Tags

More Sphinx packages