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.2.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.2.0.tar.gz | 14.5 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| autodoc_pydantic-1.2.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 30.0 kB
Release files / autodoc_pydantic-1.2.0.tar.gz
| Download URL | autodoc_pydantic-1.2.0.tar.gz |
|---|---|
| Size | 14.5 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
3758aa13fe7bd92228fa6b216b1bc0649e2af0b5ecca4b81957183f69867ab29
|
|
BLAKE2b-256 checksum How to use checksums |
82f435fe2415ecca4fd9aa2d59aa19d291fa0c8a1d7d644920d0d8ce9885a54e
|
| 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.2.0-py3-none-any.whl
| Download URL | autodoc_pydantic-1.2.0-py3-none-any.whl |
|---|---|
| Size | 15.5 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
5b1e87263ea98622550340b801e2ec02d4524bd1acea7b6b3ef0db686246873e
|
|
BLAKE2b-256 checksum How to use checksums |
a899a2735b87ea5152e8f916fabd9d246c4f1011f9e14778838cbf448cef28e9
|
| 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
|
