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.0andsphinx >= 4.0.0
📄 Documentation
| 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. |
🙏 Acknowledgements
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!
1 maintainer
Metadata
1 maintainer
Release files for autodoc_pydantic 2.2.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| autodoc_pydantic-2.2.0-py3-none-any.whl | Python 3 | none | any | Details |
Release files / autodoc_pydantic-2.2.0-py3-none-any.whl
| Download URL | autodoc_pydantic-2.2.0-py3-none-any.whl |
|---|---|
| Size | 34.0 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
8c6a36fbf6ed2700ea9c6d21ea76ad541b621fbdf16b5a80ee04673548af4d95
|
|
BLAKE2b-256 checksum How to use checksums |
7bdf87120e2195f08d760bc5cf8a31cfa2381a6887517aa89453b23f1ae3354f
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/1.8.2 CPython/3.10.14 Linux/6.5.0-1018-azure
|
