autoclasstoc
Add a succinct TOC to auto-documented classes.
Decision gist · record as of 2026-08-14
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.AI-flagged interpretation of the facts on this page — verify before relying
Before you install
- Requires Sphinx and docutils; intended for use within a Sphinx documentation build, not as a standalone library.
- Low install friction with a pure-Python wheel.
- Dormant maintenance status means no recent updates, though the repository remains active and unarchived.
License · maintenance · safety
(unclear) — 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.
last release 2024-10-15 (668 days) · last repo commit 2024-10-15 · 20 stars
0 known vulnerabilities (OSV.dev, 2026-08-14) · 182,386 downloads/mo, #10,100 on PyPI
Alternatives
Verify before relying
pip install autoclasstoc
In conf.py:
extensions = ['autoclasstoc']
In your .rst file:
.. autoclassoc:: mymodule.MyClass- 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.
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 on it.
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
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.
Requires Sphinx and docutils; intended for use within a Sphinx documentation build, not as a standalone library.
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.MyClassVerify 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
| License | Not declared unclear |
| Python support | Supports the current Python release >=3.6 |
| Install friction | Low. Pure-Python wheel |
| Runtime dependencies | 3 packagessphinxdocutilsmore_itertools |
| Maintenance | Dormant 668 days since the last release |
| Last repo commit | |
| First released | |
| Downloads | 182,386 / month, #10,100 on PyPI 30-day window, as of 2026-08-14 |
| Known vulnerabilities | None known OSV.dev, checked 2026-08-14 |
| Classifiers | Programming Language :: Python :: 3 |
Evidence: autoclasstoc-1.7.0-py3-none-any.whl
Tags
Let your AI agent find packages like this
Example. Real query, live index.
You found this page by searching. An agent finds it by wishing: SkillFed indexes 14,416 PyPI packages by what they can do, searchable in plain language.
wish › “sphinx class documentation toc”
- autoclasstocGenerates a structured table of contents for auto-documented Python…
- sphinx_external_tocA Sphinx extension that defines documentation site-maps in a single…
- mdformat-tocMdformat-toc is an mdformat plugin that automatically generates and…
Give your agent the search over MCP, or paste the wish link into any chat.
More Sphinx packages
Parses Python docstrings in ReST, Google, Numpydoc, and Epydoc formats, extracting structured information like descriptions, parameters, return types, and exceptions.
Install it if you need to programmatically read and extract structured data from Python docstrings.
Sphinx generates professional documentation from reStructuredText source files, producing HTML, PDF, EPUB, and other formats with automatic cross-references, code highlighting, and hierarchical navigation.
A Sphinx extension that outputs documentation in serialized HTML formats (JSON and pickle) alongside standard HTML.
Alabaster is a clean, responsive Sphinx theme for documentation that requires Python 3.10 or newer and Sphinx 6.2 or newer.
A Sphinx extension that generates HTML help files from reStructuredText documentation source.
A Sphinx extension that converts documentation source files into QtHelp format, enabling integration with Qt-based help systems and documentation viewers.
However, be aware that maintenance is dormant—if you rely on it long-term, monitor Sphinx compatibility and consider whether QtHelp remains the right format for your…
See also sphinx-autodoc2 · autodocsumm · sphinx_external_toc · sphinxcontrib-autoyaml · sphinxcontrib-django · sphinx-autodoc-typehints · sphinx-autoapi · changelog · autodoc_pydantic · sphinxcontrib-typer