Seamlessly integrate pydantic models in your Sphinx documentation.
Project description
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.0
andsphinx >= 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!
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for autodoc_pydantic-1.5.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | e7c04bc50b590570572add069b8e61c6c2d23878b6dd75d6a703642a9625fb80 |
|
MD5 | ee49ca3f6f8ec107fe5ad68a4c3c3c10 |
|
BLAKE2b-256 | c637da33e5396fd78da037af10742de692504e0f7684ed9b40acfa9a785a16a7 |