Skip to content
This repository has been archived by the owner on Sep 19, 2023. It is now read-only.

Seamlessly integrate pydantic models in your Sphinx documentation.

License

Notifications You must be signed in to change notification settings

Extrality/autodoc_pydantic

 
 

Repository files navigation

Autodoc Pydantic

PyPI version Python

Master Coverage

Downloads All Contributors

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, < 2.0.0 and sphinx >= 3.4.0

Comparison between autodoc sphinx and autodoc pydantic

Comparison

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:

Acknowledgements

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

Franz Wöllert
Franz Wöllert

🚧 📖 ⚠️ 🖋
Yves Renier
Yves Renier

📖 ⚠️ 🖋
TheBeardedBerserkr
TheBeardedBerserkr

🤔
Jan Vlčinský
Jan Vlčinský

🛡️
antvig
antvig

🐛 📓
Hugo O Rivera
Hugo O Rivera

🤔
yura bondarenko
yura bondarenko

🐛 📓
Trevor Howard
Trevor Howard

🐛 📓
thomas-pedot
thomas-pedot

🐛 📓
Mat Utter
Mat Utter

🐛 📓
David C Hall
David C Hall

🤔 📓
Josh A. Mitchell
Josh A. Mitchell

🤔 ⚠️
Roderick Go
Roderick Go

⚠️
Lily Wang
Lily Wang

📖 🖋
j-carson
j-carson

🐛 💻 ⚠️
Jakob Lykke Andersen
Jakob Lykke Andersen

💻
Juan Luis Cano Rodríguez
Juan Luis Cano Rodríguez

🖋
Mikalai Chaly
Mikalai Chaly

🐛 ⚠️
Stig Korsnes
Stig Korsnes

🐛 🤔
Ilia Kurenkov
Ilia Kurenkov

🐛
Grzegorz Bokota
Grzegorz Bokota

🐛
jgunstone
jgunstone

🐛
iwyrkore
iwyrkore

💻
spacemanspiff2007
spacemanspiff2007

🐛 🤔
Luke Hsiao
Luke Hsiao

🐛
Daniel Walker
Daniel Walker

🐛
Evgeniy Lupashin
Evgeniy Lupashin

🐛
Jan-Hendrik Ewers
Jan-Hendrik Ewers

🐛
Jonny Saunders
Jonny Saunders

🐛
Charles Machalow
Charles Machalow

💬
Thomas Karaouzene
Thomas Karaouzene

🐛
caseyzak24
caseyzak24

📖

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

About

Seamlessly integrate pydantic models in your Sphinx documentation.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Python 99.9%
  • CSS 0.1%