autodoc_pydantic
Seamlessly integrate pydantic models in your Sphinx documentation.
Decision gist · record as of 2026-08-14
Yes. The package solves a real friction point—Sphinx's autodoc does not natively understand pydantic metadata—with a well-maintained, low-friction extension. Active development, no known vulnerabilities, permissive license, and broad pydantic version support make it a safe choice for any project using pydantic models and Sphinx documentation.AI-flagged interpretation of the facts on this page — verify before relying
Before you install
- Requires Sphinx >= 4.0.0 and pydantic >= 1.5.0; Python >= 3.8.1, < 4.0.0.
- Low friction install with four straightforward runtime dependencies (Sphinx, pydantic, pydantic-settings, importlib-metadata).
- Active maintenance as of 2026-08-12 with 181 repository stars.
License · maintenance · safety
MIT (permissive) — MIT license (permissive) places no restrictions on use, modification, or distribution in proprietary or open-source projects.
last release 2024-04-27 (839 days) · last repo commit 2026-08-12 · 181 stars
0 known vulnerabilities (OSV.dev, 2026-08-14) · 406,522 downloads/mo, #6,896 on PyPI
Alternatives
Verify before relying
pip install autodoc_pydantic
# In conf.py, add to extensions:
extensions = ['autodoc_pydantic']
# Then use standard Sphinx autodoc on pydantic models:
# .. automodel:: mymodule.MyModel- Whether the package supports pydantic v2 models with the same feature completeness as v1 models, given the v2 classifier.
- Performance impact when documenting large numbers of pydantic models or deeply nested schemas.
- Compatibility with recent Sphinx versions beyond what the classifiers declare.
What it is and what it does
autodoc_pydantic is a Sphinx extension that bridges the gap between pydantic model definitions and Sphinx's autodoc system. When you use Sphinx to auto-document Python code containing pydantic models, autodoc normally struggles to extract and display pydantic-specific metadata like field defaults, aliases, and validation constraints. This extension teaches Sphinx how to recognize and render that metadata, so your generated documentation includes the full picture of what each model field expects.
The extension integrates natively with Sphinx's autodoc and autosummary extensions, requires only four runtime dependencies (Sphinx, pydantic, pydantic-settings, importlib-metadata), and supports pydantic versions from 1.5.0 onward. It's actively maintained and has been in use since early 2021, with a permissive MIT license.
Use it for
- Auto-generate API documentation for FastAPI or other frameworks that use pydantic models for request/response schemas.
- Document configuration classes built with pydantic-settings so users see all valid fields and their constraints in one place.
- Include collapsible JSON schema representations of pydantic models directly in your Sphinx docs.
- Maintain hyperlinks between pydantic validators and the fields they validate within generated documentation.
- Visualize class hierarchies and entity-relationship diagrams for pydantic model inheritance in your docs.
Worth the install?
AI-flagged interpretation of the facts on this page. Verify before relying on it.
Yes.
The package solves a real friction point—Sphinx's autodoc does not natively understand pydantic metadata—with a well-maintained, low-friction extension. Active development, no known vulnerabilities, permissive license, and broad pydantic version support make it a safe choice for any project using pydantic models and Sphinx documentation.
Install
autodoc-pydantic on PyPI
Before you install
Low friction install with four straightforward runtime dependencies (Sphinx, pydantic, pydantic-settings, importlib-metadata). Active maintenance as of 2026-08-12 with 181 repository stars.
Requires Sphinx >= 4.0.0 and pydantic >= 1.5.0; Python >= 3.8.1, < 4.0.0.
License in practice
MIT license (permissive) places no restrictions on use, modification, or distribution in proprietary or open-source projects.
Quickstart
pip install autodoc_pydantic
# In conf.py, add to extensions:
extensions = ['autodoc_pydantic']
# Then use standard Sphinx autodoc on pydantic models:
# .. automodel:: mymodule.MyModelVerify before relying
- Whether the package supports pydantic v2 models with the same feature completeness as v1 models, given the v2 classifier.
- Performance impact when documenting large numbers of pydantic models or deeply nested schemas.
- Compatibility with recent Sphinx versions beyond what the classifiers declare.
Package facts
| License | MIT permissive |
| Python support | Supports the current Python release <4.0.0,>=3.8.1 |
| Install friction | Low. Pure-Python wheel |
| Runtime dependencies | 4 packagesSphinxpydanticpydantic-settingsimportlib-metadata |
| Maintenance | Actively maintained 839 days since the last release |
| Last repo commit | |
| First released | |
| Downloads | 406,522 / month, #6,896 on PyPI 30-day window, as of 2026-08-14 |
| Known vulnerabilities | None known OSV.dev, checked 2026-08-14 |
| Classifiers | Framework :: PydanticFramework :: Pydantic :: 2Framework :: Sphinx :: ExtensionLicense :: OSI Approved :: MIT LicenseProgramming Language :: Python :: 3Programming Language :: Python :: 3.10Programming Language :: Python :: 3.11Programming Language :: Python :: 3.12Programming Language :: Python :: 3.9Topic :: Documentation :: SphinxTopic :: Software Development :: Documentation |
Evidence: autodoc_pydantic-2.2.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 › “pydantic sphinx documentation”
- autodoc_pydanticSphinx extension that automatically generates documentation for…
- quartodocquartodoc generates Python API reference documentation from…
- alabasterAlabaster is a clean, responsive Sphinx theme for documentation that…
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-autodoc-typehints · sphinx-autoapi · sphinxcontrib-autoyaml · sphinxcontrib-django · sphinxcontrib-apidoc · pydantic-extra-types · sphinx-autodoc2 · exhale · avidtools