Welcome to autodoc_pydantic’s documentation!
Seamlessly integrate pydantic models in your Sphinx documentation.
You love pydantic 💖 and you want to
document your models and configuration settings with sphinx?
Perfect, let’s go. But wait, sphinx’ autodoc
does not integrate too well with pydantic models 😕.
Don’t worry - just pip install autodoc_pydantic
😉.
Features
💬 provides default values, alias and constraints for model fields
🔗 adds hyperlinks between validators and corresponding fields
📃 includes collapsable model json schema
🏄 natively integrates with autodoc and autosummary extensions
📎 defines explicit pydantic prefixes for models, settings, fields, validators and model config
📋 shows summary section for model configuration, fields and validators
👀 hides overloaded and redundant model class signature
🔱 visualizes entity-relationship-diagrams for class hierarchies
🔨 allows complete configurability on global and per-model level
🍀 supports pydantic >= 1.5.0 and sphinx >= 4.0.0
To see those features in action, jump over to the example section comparing the appearance of standard sphinx autodoc with autodoc_pydantic.
Note
This documentation is based on autodoc_pydantic >= 2.0.1
. If you are
using pydantic v1 along with autodoc_pydantic < 2.0.0
, please find the
latest v1 documentation here .
Acknowledgements
Thanks to great open source projects
and many more involved
and all contributors to autodoc_pydantic ❤!