mansenfranzen / autodoc_pydantic

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.0 and sphinx >= 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:

• Installation
• Configuration
• Usage
• Examples

Acknowledgements

Thanks to great open source projects sphinx, pydantic and poetry (and so many more) ❤ in addition to the following contributors:

Franz Wöllert 🚧 📖 ⚠️ 🖋	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 🐛

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