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 extension
- 📎 defines explicit pydantic prefixes for models, settings, fields, validators and model config
- 📋 shows summary section for model configuration 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) ❤️ !
1 maintainer
Metadata
1 maintainer
Release files for autodoc_pydantic 1.1.1
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.1.tar.gz | 13.0 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| autodoc_pydantic-1.1.1-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 26.8 kB
Release files / autodoc_pydantic-1.1.1.tar.gz
| Download URL | autodoc_pydantic-1.1.1.tar.gz |
|---|---|
| Size | 13.0 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
31b38f83b070535b9834330aeed24c7412d7c8d5636e48f09556ce11118e1984
|
|
BLAKE2b-256 checksum How to use checksums |
c4e2b31a007cceb2339ea08e7cb1f18e2c38c149f4bc549b47c545066cba2ef3
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/1.0.0 CPython/3.9.4 Linux/5.4.0-1046-azure
|
Release files / autodoc_pydantic-1.1.1-py3-none-any.whl
| Download URL | autodoc_pydantic-1.1.1-py3-none-any.whl |
|---|---|
| Size | 13.8 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
6a1218e85109054531c8e9531355b3ace96f7212b1bc0926ed42c445bd570e5a
|
|
BLAKE2b-256 checksum How to use checksums |
90c6a8439c00bc2435e2d64d1c1e39f7ea5721f64e9bb3e34de8f844da0c1460
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/1.0.0 CPython/3.9.4 Linux/5.4.0-1046-azure
|
