sphinx-automodapi

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

Sphinx extension that automatically generates API documentation pages for entire Python modules, reducing manual documentation overhead by introspecting module contents.

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

pip install sphinx-automodapi

uv add sphinx-automodapi

poetry add sphinx-automodapi

Installing sphinx-automodapi

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.

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:: mymodule

Requires Python 3.10 or later; sphinx must be installed and configured with a conf.py file.

Verify 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

Evidence: sphinx_automodapi-0.22.0-py3-none-any.whl

Tags

More Sphinx packages