Seamlessly integrate pydantic models in your Sphinx documentation.
Project description
You love pydantic :heart: 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 :confused:.
Don't worry - just pip install autodoc_pydantic
:relaxed:.
Features
- :speech_balloon: provides default values, alias and constraints for model fields
- :link: adds references between validators and corresponding fields
- :page_with_curl: includes collapsable model json schema
- :surfer: natively integrates with autodoc extension
- :paperclip: defines explicit pydantic prefixes for models, settings, fields, validators and model config
- :clipboard: shows summary section for model configuration and validators
- :eyes: hides overloaded and redundant model class signature
- :books: 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) :heart: !
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.1.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1d1e05ffca9ad2b5e02d53ebdc600cf5f43acbe85409e2bffe79a16befeb4a25 |
|
MD5 | 5dd76b6a02ea6124767df2cedd7545f5 |
|
BLAKE2b-256 | 91ae518e894988d3a81fdd866d02941cc86c1997c65ce38f3a555673a78dd1ca |