autodocsumm
Extended sphinx autodoc including automatic autosummaries
Decision gist · record as of 2026-08-14
Yes. Low install friction, no known vulnerabilities, permissive license, active maintenance, and production-stable status. Install if you use Sphinx autodoc and want automatic summary tables in your API documentation without manual configuration per directive.AI-flagged interpretation of the facts on this page — verify before relying
Before you install
- Low friction install with only Sphinx as a runtime dependency.
- Actively maintained with recent releases; last commit 2026-03-26 and marked as production-stable.
License · maintenance · safety
Apache-2.0 (permissive) — Licensed under Apache-2.0 (permissive), allowing use in commercial and private projects with minimal restrictions beyond attribution and liability disclaimers.
last release 2026-03-26 (141 days) · last repo commit 2026-03-26 · 53 stars
0 known vulnerabilities (OSV.dev, 2026-08-14) · 916,718 downloads/mo, #4,730 on PyPI
Alternatives
Verify before relying
pip install autodocsumm
In conf.py:
extensions = [
'sphinx.ext.autodoc',
'autodocsumm',
]
Then use :autosummary: option on autodoc directives or set autodoc_default_options = {'autosummary': True}What it is and what it does
autodocsumm is a Sphinx extension that augments the built-in autodoc extension to automatically generate summary tables in API documentation. When you document a module, class, or function using autodoc directives, autodocsumm adds a table-of-contents-style summary listing all methods, classes, functions, and attributes at the top of the generated documentation, similar to the autosummary extension but integrated directly into autodoc output.
The extension also adds configuration options to include documentation from special methods like `__call__` (via autodata_content) and to exclude the string representation of large objects (via not_document_data). It requires only Sphinx to run and integrates by adding 'autodocsumm' to your Sphinx conf.py extensions list, then using the :autosummary: option on autodoc directives or enabling it globally via autodoc_default_options.
Use it for
- Generate API reference docs with automatic summary tables for large module hierarchies without manual curation.
- Include __call__ method documentation in class autodoc output for callable objects and functors.
- Exclude verbose string representations of configuration dictionaries or large data structures from generated docs.
- Activate summary tables globally across all autodoc directives in a Sphinx project via conf.py configuration.
Worth the install?
AI-flagged interpretation of the facts on this page. Verify before relying on it.
Yes.
Low install friction, no known vulnerabilities, permissive license, active maintenance, and production-stable status. Install if you use Sphinx autodoc and want automatic summary tables in your API documentation without manual configuration per directive.
Install
autodocsumm on PyPI
Before you install
Low friction install with only Sphinx as a runtime dependency. Actively maintained with recent releases; last commit 2026-03-26 and marked as production-stable.
License in practice
Licensed under Apache-2.0 (permissive), allowing use in commercial and private projects with minimal restrictions beyond attribution and liability disclaimers.
Quickstart
pip install autodocsumm
In conf.py:
extensions = [
'sphinx.ext.autodoc',
'autodocsumm',
]
Then use :autosummary: option on autodoc directives or set autodoc_default_options = {'autosummary': True}Package facts
| License | Apache-2.0 permissive |
| Python support | Supports the current Python release >=3.7 |
| Install friction | Low. Pure-Python wheel |
| Runtime dependencies | 1 packageSphinx |
| Maintenance | Actively maintained 141 days since the last release |
| Last repo commit | |
| First released | |
| Downloads | 916,718 / month, #4,730 on PyPI 30-day window, as of 2026-08-14 |
| Known vulnerabilities | None known OSV.dev, checked 2026-08-14 |
| Classifiers | Development Status :: 5 - Production/StableFramework :: SphinxFramework :: Sphinx :: ExtensionIntended Audience :: DevelopersLicense :: OSI Approved :: Apache Software LicenseOperating System :: OS IndependentProgramming Language :: Python :: 3Programming Language :: Python :: 3 :: OnlyProgramming Language :: Python :: 3.10Programming Language :: Python :: 3.11Programming Language :: Python :: 3.12Programming Language :: Python :: 3.7Programming Language :: Python :: 3.8Programming Language :: Python :: 3.9Topic :: Documentation |
Evidence: autodocsumm-0.2.15-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 autodoc summary tables”
- autodocsummA Sphinx extension that enhances autodoc with automatic summary…
- autoclasstocGenerates a structured table of contents for auto-documented Python…
- autodoc_pydanticSphinx extension that automatically generates documentation for…
Give your agent the search over MCP, or paste the wish link into any chat.
More Documentation packages
Docutils converts plaintext documentation in reStructuredText format into multiple output formats including HTML, XML, and LaTeX using a modular processing system.
Sphinx generates professional documentation from reStructuredText source files, producing HTML, PDF, EPUB, and other formats with automatic cross-references, code highlighting, and hierarchical navigation.
Griffe extracts the complete structure and signatures of Python programs to generate API documentation or detect breaking changes in your project's public API.
Install it if you need to programmatically inspect Python code structure, generate API docs, or enforce API stability in CI.
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.
See also autodoc_pydantic · sphinx-autoapi · sphinx-autosummary-accessors · sphinxcontrib-apidoc · sphinxcontrib-autoyaml · sphinxcontrib-django · autoclasstoc · sphinx-click · sphinx-autodoc-typehints · sphinx-last-updated-by-git