Seamlessly integrate pydantic models in your Sphinx documentation.
Project Links
Meta
Author: mansenfranzen
Requires Python: >=3.8.1,<4.0.0
Classifiers
Framework
- Pydantic
- Pydantic :: 2
- Sphinx :: Extension
License
- OSI Approved :: MIT License
Programming Language
- Python :: 3
- Python :: 3.9
- Python :: 3.10
- Python :: 3.11
- Python :: 3.12
Topic
- Documentation :: Sphinx
- Software Development :: Documentation
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.0
andsphinx >= 4.0.0
π Documentation
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. |
π 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!
Apr 27, 2024
2.2.0
Mar 18, 2024
2.1.0
Aug 01, 2023
2.0.1
Jul 24, 2023
2.0.0
Apr 12, 2024
1.9.1
Jul 03, 2023
1.9.0
Oct 13, 2022
1.8.0
Jun 12, 2022
1.7.2
May 30, 2022
1.7.1
May 18, 2022
1.7.0
Apr 15, 2022
1.6.2
Jan 28, 2022
1.6.1
Jan 03, 2022
1.6.0
Nov 12, 2021
1.5.1
Oct 10, 2021
1.5.0
Aug 20, 2021
1.4.0
Jul 21, 2021
1.3.1
May 11, 2021
1.3.0
May 10, 2021
1.2.0
May 08, 2021
1.1.3
May 06, 2021
1.1.2
Apr 26, 2021
1.1.1
Apr 24, 2021
1.1.0
Apr 23, 2021
1.0.0
Apr 04, 2021
0.1.1
Mar 30, 2021
0.1.0
Wheel compatibility matrix
Files in release
Extras:
Dependencies:
(>=4.0)
Sphinx
(>1)
importlib-metadata
(<3.0.0,>=2.0)
pydantic
(<3.0.0,>=2.0)
pydantic-settings