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
βΊ.
pydantic >= 1.5.0
and sphinx >= 4.0.0
Section | Description |
---|---|
π Landing Page | Guides and detailed information. |
π οΈ Installation | Setup and installation procedures. |
π§ Configuration | System or application settings. |
π‘ Usage | How to use the application or tool. |
π Examples | Showcase and usage examples. |
π¨βπ» Developer Guide | In-depth guide for developers. |
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!