Seamlessly integrate pydantic models in your Sphinx documentation
autodoc_pydantic
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
- 📚 sorts fields, validators and model config within models by type