autodoc_pydantic 2.2.0

Seamlessly integrate pydantic models in your Sphinx 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 and sphinx >= 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:

Franz Wöllert 🚧 📖 ⚠️ 🖋	Yves Renier 📖 ⚠️ 🖋	TheBeardedBerserkr 🤔	Jan Vlčinský 🛡️	antvig 🐛 📓	Hugo O Rivera 🤔	yura bondarenko 🐛 📓
Trevor Howard 🐛 📓	thomas-pedot 🐛 📓	Mat Utter 🐛 📓	David C Hall 🤔 📓	Josh A. Mitchell 🤔 ⚠️	Roderick Go ⚠️	Lily Wang 📖 🖋
j-carson 🐛 💻 ⚠️	Jakob Lykke Andersen 💻	Juan Luis Cano Rodríguez 🖋	Mikalai Chaly 🐛 ⚠️	Stig Korsnes 🐛 🤔	Ilia Kurenkov 🐛	Grzegorz Bokota 🐛
jgunstone 🐛	iwyrkore 💻	spacemanspiff2007 🐛 🤔	Luke Hsiao 🐛	Daniel Walker 🐛	Evgeniy Lupashin 🐛	Jan-Hendrik Ewers 🐛
Jonny Saunders 🐛	Charles Machalow 💬	Thomas Karaouzene 🐛	caseyzak24 📖	Priscila Oliveira 👀 📓	Arthur Woimbée 👀 📓 💻 ⚠️	Chris Markiewicz 🐛
David B. Nagle 🐛	JerryJia 💻	Mike D 💻 🐛 ⚠️	Dario Quintero (Flexcompute) 👀	Rafael Guedes 💻	Andrew Linzie 💻	Altay Sansal 🤔
Tony Narlock 💻 📖	Xuan (Sean) Hu 🐛	Christian Riedel 🐛	morcef 🐛	alejandro-yousef 🤔	exs-dwoodward 💻	Leah Wasser 🐛
Allan Galarza 🐛	Carson-Shaar 🐛	Kyle Finley 🐛	brunocruz 🐛	Anne Rademacher 💵	Éloi Rivard 🐛

This project follows the all-contributors specification. Contributions of any kind welcome!