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) ❤!
1 maintainer
Metadata
1 maintainer
Release files for autodoc_pydantic 1.3.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.3.1.tar.gz | 15.4 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| autodoc_pydantic-1.3.1-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 32.2 kB
Release files / autodoc_pydantic-1.3.1.tar.gz
| Download URL | autodoc_pydantic-1.3.1.tar.gz |
|---|---|
| Size | 15.4 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
bf06e82edc370004bbe16f8f823a6f94fdc21602fcce3805c4d44a29746d51ec
|
|
BLAKE2b-256 checksum How to use checksums |
8e31732136a869fe1491a955f2e62559496ed07c8e9909b2508557a67377c7b9
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/1.0.0 CPython/3.9.6 Linux/5.8.0-1036-azure
|
Release files / autodoc_pydantic-1.3.1-py3-none-any.whl
| Download URL | autodoc_pydantic-1.3.1-py3-none-any.whl |
|---|---|
| Size | 16.7 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
b068d6a967a7722b9a98c3675439d5c0a1a1235d917e42be287c918dadb691bf
|
|
BLAKE2b-256 checksum How to use checksums |
d8a70794d4e37a5b41d6fb2f5964aeb9de1f86c694eacdf651afc2034b197600
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/1.0.0 CPython/3.9.6 Linux/5.8.0-1036-azure
|
