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
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distributions
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file autodoc_pydantic-2.2.0-py3-none-any.whl.
File metadata
- Download URL: autodoc_pydantic-2.2.0-py3-none-any.whl
- Upload date:
- Size: 34.0 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via:
poetry/1.8.2 CPython/3.10.14 Linux/6.5.0-1018-azure
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
8c6a36fbf6ed2700ea9c6d21ea76ad541b621fbdf16b5a80ee04673548af4d95
|
|
| MD5 |
a5dd42db762f47fb6c988a454b47ea2d
|
|
| BLAKE2b-256 |
7bdf87120e2195f08d760bc5cf8a31cfa2381a6887517aa89453b23f1ae3354f
|
