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 references 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) ❤!
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
autodoc_pydantic-1.3.0.tar.gz
(14.8 kB
view hashes)
Built Distribution
Close
Hashes for autodoc_pydantic-1.3.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2550bdbcfa3952fdc1d7c6b0bf2d8f19544579d142488a66d86d06237c8bccca |
|
MD5 | 40b451d267522fc0682866a5fa8410a1 |
|
BLAKE2b-256 | 8a33d9c46c1b4f2efc95319affdf9a7248a8e5a7f837bbd5ffaa38aabae4c8e0 |