sphinx-automodapi
Sphinx extension for auto-generating API documentation for entire modules
Decision gist · record as of 2026-08-14
Yes, if you maintain a Python package and use Sphinx for documentation. The low install friction, permissive license, active maintenance, and zero known vulnerabilities make it a safe choice. The main caveat is that feature development is limited to Astropy's own needs, so highly specialized requirements may not be addressed—but for standard API documentation generation, it is reliable and well-established.AI-flagged interpretation of the facts on this page — verify before relying
Before you install
- Requires Python 3.10 or later; sphinx must be installed and configured with a conf.py file.
- Low install friction with just two runtime dependencies (packaging and sphinx).
- Active maintenance with a recent release in December 2025 and ongoing repository activity; last commit in August 2026 indicates current engagement.
License · maintenance · safety
BSD-3-Clause (permissive) — BSD-3-Clause is a permissive open-source license that allows commercial use, modification, and distribution with minimal restrictions—suitable for most projects.
last release 2025-12-13 (244 days) · last repo commit 2026-08-03 · 67 stars
0 known vulnerabilities (OSV.dev, 2026-08-14) · 200,581 downloads/mo, #9,689 on PyPI
Alternatives
Verify before relying
pip install sphinx-automodapi
In conf.py:
extensions = ['sphinx_automodapi.automodapi']
In your .rst file:
.. automodapi:: mymodule- Whether the extension handles nested submodules and complex package hierarchies automatically.
- Performance characteristics when applied to very large modules or packages.
- Compatibility with recent Sphinx versions beyond what the fact sheet indicates.
What it is and what it does
sphinx-automodapi is a Sphinx extension that inspects Python modules and automatically generates API documentation pages without requiring manual page creation or detailed docstring scaffolding. It was originally built for the Astropy project but works as a standalone tool for any Python package. The extension reads module structure and docstrings, then outputs formatted API reference pages that Sphinx can build into HTML or other formats.
The package depends on Sphinx for the documentation framework and packaging for version handling. It targets developers who maintain Python libraries and want to reduce the burden of keeping API documentation synchronized with code changes. The extension is stable (production status) and actively maintained, though the Astropy project notes that feature additions are limited to what the project itself requires.
Use it for
- Generate API reference documentation for a Python library without manually creating individual documentation files for each module.
- Keep API docs in sync with code by automatically reflecting module structure and public APIs during documentation builds.
- Reduce documentation maintenance overhead in projects where modules change frequently or have many submodules.
- Create consistent, searchable API reference pages that Sphinx can integrate into a larger documentation site.
Worth the install?
AI-flagged interpretation of the facts on this page. Verify before relying on it.
Yes, if you maintain a Python package and use Sphinx for documentation.
The low install friction, permissive license, active maintenance, and zero known vulnerabilities make it a safe choice. The main caveat is that feature development is limited to Astropy's own needs, so highly specialized requirements may not be addressed—but for standard API documentation generation, it is reliable and well-established.
Install
sphinx-automodapi on PyPI
Before you install
Low install friction with just two runtime dependencies (packaging and sphinx). Active maintenance with a recent release in December 2025 and ongoing repository activity; last commit in August 2026 indicates current engagement.
Requires Python 3.10 or later; sphinx must be installed and configured with a conf.py file.
License in practice
BSD-3-Clause is a permissive open-source license that allows commercial use, modification, and distribution with minimal restrictions—suitable for most projects.
Quickstart
pip install sphinx-automodapi
In conf.py:
extensions = ['sphinx_automodapi.automodapi']
In your .rst file:
.. automodapi:: mymoduleVerify before relying
- Whether the extension handles nested submodules and complex package hierarchies automatically.
- Performance characteristics when applied to very large modules or packages.
- Compatibility with recent Sphinx versions beyond what the fact sheet indicates.
Package facts
| License | BSD-3-Clause permissive |
| Python support | Supports the current Python release >=3.10 |
| Install friction | Low. Pure-Python wheel |
| Runtime dependencies | 2 packagespackagingsphinx |
| Maintenance | Actively maintained 244 days since the last release |
| Last repo commit | |
| First released | |
| Downloads | 200,581 / month, #9,689 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/StableIntended Audience :: DevelopersOperating System :: OS IndependentProgramming Language :: PythonProgramming Language :: Python :: 3 |
Evidence: sphinx_automodapi-0.22.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 › “automatic module api docs”
- sphinx-automodapiSphinx extension that automatically generates API documentation pages…
- mkdocs-api-autonavAutomatically generates API reference documentation and navigation…
- pdoc3Generates API documentation for Python 3+ projects automatically from…
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 · sphinx-argparse · sphinx-autoapi · sphinx-panels · sphinx-click · sphinxext-opengraph · sphinx-remove-toctrees · sphinxcontrib-autoyaml · sphinx-reredirects · sphinx-gallery