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!