sphinx-autoapi
Sphinx API documentation generator
Decision gist · record as of 2026-08-14
Yes. This is a mature, actively maintained Sphinx extension with low install friction, no vulnerabilities, and a permissive license. It solves a real problem—generating complete API docs from source code without imports—that makes it valuable for projects where autodoc is impractical. Install it if you use Sphinx and want automatic API documentation.AI-flagged interpretation of the facts on this page — verify before relying
Before you install
- Requires Python 3.10 or later and an existing Sphinx project to extend.
- Low friction: a pure-Python wheel with four straightforward runtime dependencies (astroid, Jinja2, PyYAML, sphinx).
- Active maintenance with a recent release and no known vulnerabilities.
License · maintenance · safety
permissive license (permissive) — MIT license (permissive); you can use, modify, and distribute this package freely in commercial and private projects with minimal restrictions.
last release 2026-03-08 (159 days) · last repo commit 2026-08-01 · 495 stars
0 known vulnerabilities (OSV.dev, 2026-08-14) · 3,679,337 downloads/mo, #2,530 on PyPI
Alternatives
Verify before relying
pip install sphinx-autoapi
# In conf.py:
extensions.append('autoapi.extension')
autoapi_dirs = ['path/to/source/files', 'src']- Whether AutoAPI handles all language types equally well (the fact sheet confirms it parses source code but does not specify which languages).
- Performance characteristics when documenting very large codebases or deeply nested module hierarchies.
What it is and what it does
Sphinx AutoAPI is a Sphinx extension that generates API documentation by parsing source code directly, rather than importing and introspecting live modules. Unlike the traditional Sphinx autodoc extension, AutoAPI finds and documents your code without needing to run or load it, making it safer for documenting untrusted or complex projects. It integrates into your Sphinx build process, automatically creating an `autoapi/` directory with generated documentation and adding it to your table of contents.
The package depends on astroid for code parsing, Jinja2 for templating, PyYAML for configuration, and sphinx itself. It supports current Python versions (3.10 through 3.14) and has been actively maintained since 2015, with no known security vulnerabilities. Installation is straightforward—a single pip command and two lines in your Sphinx conf.py—and the extension then handles the rest during documentation builds.
Use it for
- Generate API docs for a Python project without importing code that may have external dependencies or side effects.
- Automatically document a large codebase where manual autodoc directives would be tedious or error-prone.
- Create API reference documentation that stays in sync with source code during the build process.
- Document multiple source directories or packages in a single Sphinx project without hand-writing module indices.
Worth the install?
AI-flagged interpretation of the facts on this page. Verify before relying on it.
Yes.
This is a mature, actively maintained Sphinx extension with low install friction, no vulnerabilities, and a permissive license. It solves a real problem—generating complete API docs from source code without imports—that makes it valuable for projects where autodoc is impractical. Install it if you use Sphinx and want automatic API documentation.
Install
sphinx-autoapi on PyPI
Before you install
Low friction: a pure-Python wheel with four straightforward runtime dependencies (astroid, Jinja2, PyYAML, sphinx). Active maintenance with a recent release and no known vulnerabilities.
Requires Python 3.10 or later and an existing Sphinx project to extend.
License in practice
MIT license (permissive); you can use, modify, and distribute this package freely in commercial and private projects with minimal restrictions.
Quickstart
pip install sphinx-autoapi
# In conf.py:
extensions.append('autoapi.extension')
autoapi_dirs = ['path/to/source/files', 'src']Verify before relying
- Whether AutoAPI handles all language types equally well (the fact sheet confirms it parses source code but does not specify which languages).
- Performance characteristics when documenting very large codebases or deeply nested module hierarchies.
Package facts
| License | permissive license permissive |
| Python support | Supports the current Python release >=3.10 |
| Install friction | Low. Pure-Python wheel |
| Runtime dependencies | 4 packagesastroidJinja2PyYAMLsphinx |
| Maintenance | Actively maintained 159 days since the last release |
| Last repo commit | |
| First released | |
| Downloads | 3,679,337 / month, #2,530 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/StableEnvironment :: PluginsFramework :: Sphinx :: ExtensionIntended Audience :: DevelopersLicense :: OSI Approved :: MIT LicenseNatural Language :: EnglishProgramming Language :: PythonProgramming Language :: Python :: 3Programming Language :: Python :: 3.10Programming Language :: Python :: 3.11Programming Language :: Python :: 3.12Programming Language :: Python :: 3.13Programming Language :: Python :: 3.14 |
Evidence: sphinx_autoapi-3.8.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 extension autodoc alternative”
- sphinx-autoapiSphinx AutoAPI generates complete API documentation by parsing source…
- autodocsummA Sphinx extension that enhances autodoc with automatic summary…
- autodoc_pydanticSphinx extension that automatically generates documentation for…
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 autodocsumm · sphinx-autodoc2 · autodoc_pydantic · sphinxcontrib-apidoc · sphinx-autodoc-typehints · sphinx-automodapi · sphinxcontrib-autoyaml · sphinxcontrib-django · sphinx-click