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.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) :heart: !
1 maintainer
Metadata
1 maintainer
Release files for autodoc_pydantic 1.1.3
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.1.3.tar.gz | 14.3 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| autodoc_pydantic-1.1.3-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 29.6 kB
Release files / autodoc_pydantic-1.1.3.tar.gz
| Download URL | autodoc_pydantic-1.1.3.tar.gz |
|---|---|
| Size | 14.3 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
db94f082d2c19e45d19844b7f64bd0b66f3e7961ce38da4344ca8adc839df8fa
|
|
BLAKE2b-256 checksum How to use checksums |
fec1bc227ddee421fa84f908d2d242ea2a77a99c42a3c812d042ca9b1912ad8b
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/1.0.0 CPython/3.9.5 Linux/5.4.0-1046-azure
|
Release files / autodoc_pydantic-1.1.3-py3-none-any.whl
| Download URL | autodoc_pydantic-1.1.3-py3-none-any.whl |
|---|---|
| Size | 15.3 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
970dc4534812bddfcd29a8efc2829bb851050fcdee542d5d733ae301f34f6f03
|
|
BLAKE2b-256 checksum How to use checksums |
326102a7ceb488f690e94c8e00e6485d9bf92de99a7d7246915d14da97266195
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/1.0.0 CPython/3.9.5 Linux/5.4.0-1046-azure
|
