{"categories":[{"label":"Sphinx","url":"https://skillfed.io/packages/category/documentation-sphinx"},{"label":"Documentation","url":"https://skillfed.io/packages/category/software-development-documentation"}],"enrichment":{"capability":"Sphinx extension that automatically generates documentation for pydantic models and settings, integrating pydantic's field metadata (defaults, aliases, constraints) directly into Sphinx autodoc output.","skillfed_tags":["sphinx-extension","pydantic-integration","api-documentation"],"use_cases":["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."],"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.\n\nThe 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.","worth_installing":"Yes. The package solves a real friction point\u2014Sphinx's autodoc does not natively understand pydantic metadata\u2014with 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."},"id":"autodoc-pydantic","links":{"html":"https://skillfed.io/packages/autodoc-pydantic","md":"https://skillfed.io/packages/autodoc-pydantic.md","pypi":"https://pypi.org/project/autodoc-pydantic/"},"maintenance":{"status":"active"},"meta":{"latest_release":"2024-04-27","license_spdx":null,"license_treatment":"permissive","name":"autodoc_pydantic","python_support":"supports_current","summary":"Seamlessly integrate pydantic models in your Sphinx documentation."},"popularity":{"monthly_downloads":406522,"position":6896,"tier":"top_15000"},"security":{"n_vulnerabilities":0},"version":"2.2.0"}