autodoc_pydantic
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
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 for the great open source projects sphinx, pydantic and poetry (and so many more) ❤️ !
1 maintainer
Metadata
1 maintainer
Release files for autodoc_pydantic 1.0.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.0.0.tar.gz | 12.4 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| autodoc_pydantic-1.0.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 25.7 kB
Release files / autodoc_pydantic-1.0.0.tar.gz
| Download URL | autodoc_pydantic-1.0.0.tar.gz |
|---|---|
| Size | 12.4 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
d7fa00021a8e5b5e2db3fe025a889aa5052e102589e69f0066c87e758dc46e61
|
|
BLAKE2b-256 checksum How to use checksums |
da3dfd28617e1fe28575c61e6dab92cf2de47377f539a47e2d621fbae50ff407
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/1.1.6 CPython/3.9.4 Windows/10
|
Release files / autodoc_pydantic-1.0.0-py3-none-any.whl
| Download URL | autodoc_pydantic-1.0.0-py3-none-any.whl |
|---|---|
| Size | 13.3 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
b5e5ffb9815354757f734d20519b8645be3c0c60203a736f1aabad52ecd835dd
|
|
BLAKE2b-256 checksum How to use checksums |
b16bff51ab015878da52d4cb019e3d00b1a9855969e368c1b1109253722a5d71
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/1.1.6 CPython/3.9.4 Windows/10
|
