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.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) ❤ in addition to the following contributors:
This project follows the all-contributors specification. Contributions of any kind welcome!
1 maintainer
Metadata
1 maintainer
Release files for autodoc_pydantic 1.7.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.7.0.tar.gz | 25.3 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| autodoc_pydantic-1.7.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 53.1 kB
Release files / autodoc_pydantic-1.7.0.tar.gz
| Download URL | autodoc_pydantic-1.7.0.tar.gz |
|---|---|
| Size | 25.3 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
c48f80431fa45a531333dac96584efe8ce2177d5ffd0af21b6b4eadd6f1dd1df
|
|
BLAKE2b-256 checksum How to use checksums |
627e7a5ce58f378e6c7742c228d9b6bedbc9f98460382b4433f89a4ba9a7502f
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/1.0.0 CPython/3.8.12 Linux/5.13.0-1023-azure
|
Release files / autodoc_pydantic-1.7.0-py3-none-any.whl
| Download URL | autodoc_pydantic-1.7.0-py3-none-any.whl |
|---|---|
| Size | 27.8 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
5bb1561647e8bc2c3c66a5331b15e4c458c5dba04c21b027a0c0306b8d39ae9b
|
|
BLAKE2b-256 checksum How to use checksums |
6656980c8fe0bb4b59d43c7cc7cd2984eca9c88fd698a92bbd380593a497c5c5
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/1.0.0 CPython/3.8.12 Linux/5.13.0-1023-azure
|
