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 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) ❤!
1 maintainer
Metadata
1 maintainer
Release files for autodoc_pydantic 1.3.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.3.0.tar.gz | 14.8 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| autodoc_pydantic-1.3.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 31.0 kB
Release files / autodoc_pydantic-1.3.0.tar.gz
| Download URL | autodoc_pydantic-1.3.0.tar.gz |
|---|---|
| Size | 14.8 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
329e03708fd8445437563130287355e33100bbd77f00530609a1557f38e9e0d8
|
|
BLAKE2b-256 checksum How to use checksums |
d15abe4c79bcb7d06024d315f0fc08dc9d546c96ba72910a2fe67618b891e44e
|
| 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.3.0-py3-none-any.whl
| Download URL | autodoc_pydantic-1.3.0-py3-none-any.whl |
|---|---|
| Size | 16.2 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
2550bdbcfa3952fdc1d7c6b0bf2d8f19544579d142488a66d86d06237c8bccca
|
|
BLAKE2b-256 checksum How to use checksums |
8a33d9c46c1b4f2efc95319affdf9a7248a8e5a7f837bbd5ffaa38aabae4c8e0
|
| 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
|
