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
π± visualizes entity-relationship-diagrams for class hierarchies
π¨ allows complete configurability on global and per-model level
π supports
pydantic >= 1.5.0andsphinx >= 4.0.0
π Documentationο
Section |
Description |
|---|---|
Guides and detailed information. |
|
Setup and installation procedures. |
|
System or application settings. |
|
How to use the application or tool. |
|
Showcase and usage examples. |
|
In-depth guide for developers. |
π 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!