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
- 🍀 Supports
pydantic >= 1.5.0andsphinx >= 3.4.0
Comparison between autodoc sphinx and autodoc pydantic
To see those features in action, jump over to the example documentation to compare the appearance of standard sphinx autodoc with autodoc_pydantic.
Documentation
For more details, please visit the official documentation:
Acknowledgements
Thanks to great open source projects sphinx, pydantic and poetry (and so many more) ❤ in addition to the following contributors:
 Franz Wöllert 🚧 📖 ⚠️ 🖋 |
 TheBeardedBerserkr 🤔 |
 Jan Vlčinský 🛡️ |
 antvig 🐛 📓 |
 Hugo O Rivera 🤔 |
 yura bondarenko 🐛 📓 |
 Trevor Howard 🐛 📓 |
 thomas-pedot 🐛 📓 |
 Mat Utter 🐛 📓 |
 David C Hall 🤔 📓 |
 Josh A. Mitchell 🤔 |
 Roderick Go ⚠️ |
This project follows the all-contributors specification. Contributions of any kind welcome!
1 maintainer
Metadata
1 maintainer
Release files for autodoc_pydantic 1.5.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| autodoc_pydantic-1.5.0.tar.gz | 21.7 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| autodoc_pydantic-1.5.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 46.0 kB
Release files / autodoc_pydantic-1.5.0.tar.gz
| Download URL | autodoc_pydantic-1.5.0.tar.gz |
|---|---|
| Size | 21.7 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
82aad0ea4a49efd6446dc9001d74d13d908138b846d3eacd524821bce2671da2
|
|
BLAKE2b-256 checksum How to use checksums |
afd178c2371c7b2efca462f3bb6c7594579cf3aed840469f2a49cde857077726
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/1.0.0 CPython/3.9.7 Linux/5.8.0-1042-azure
|
Release files / autodoc_pydantic-1.5.0-py3-none-any.whl
| Download URL | autodoc_pydantic-1.5.0-py3-none-any.whl |
|---|---|
| Size | 24.3 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
e7c04bc50b590570572add069b8e61c6c2d23878b6dd75d6a703642a9625fb80
|
|
BLAKE2b-256 checksum How to use checksums |
c637da33e5396fd78da037af10742de692504e0f7684ed9b40acfa9a785a16a7
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/1.0.0 CPython/3.9.7 Linux/5.8.0-1042-azure
|
