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 βΊ.
- π¬ 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.0andsphinx >= 4.0.0
| Section | Description |
|---|---|
| π Landing Page | Guides and detailed information. |
| π οΈ Installation | Setup and installation procedures. |
| π§ Configuration | System or application settings. |
| π‘ Usage | How to use the application or tool. |
| π Examples | Showcase and usage examples. |
| π¨βπ» Developer Guide | In-depth guide for developers. |
Thanks to great open source projects sphinx, pydantic and poetry (and so many more) β€ in addition to the following contributors:
This project follows the all-contributors specification. Contributions of any kind welcome!