autodoc_pydantic

Seamlessly integrate pydantic models in your Sphinx documentation.

MIT 26 个版本 Python <4.0.0,>=3.8.1

mansenfranzen <franz.woellert@gmail.com>

安装

pip install autodoc_pydantic

poetry add autodoc_pydantic

pipenv install autodoc_pydantic

conda install autodoc_pydantic

描述

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
🔱 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!

分类

Framework :: Pydantic Framework :: Pydantic :: 2 Framework :: Sphinx :: Extension License :: OSI Approved :: MIT License Programming Language :: Python :: 3 Programming Language :: Python :: 3.10 Programming Language :: Python :: 3.11 Programming Language :: Python :: 3.12 Programming Language :: Python :: 3.9 Topic :: Documentation :: Sphinx Topic :: Software Development :: Documentation

版本列表

2.2.0 2024-04-27

2.1.0 2024-03-18

2.0.1 2023-08-01

2.0.0 2023-07-24

1.9.1 2024-04-12

1.9.0 2023-07-03

1.8.0 2022-10-13

1.7.2 2022-06-12

1.7.1 2022-05-30

1.7.0 2022-05-18

1.6.2 2022-04-15

1.6.1 2022-01-28

1.6.0 2022-01-03

1.5.1 2021-11-12

1.5.0 2021-10-10

1.4.0 2021-08-20

1.3.1 2021-07-21

1.3.0 2021-05-11

1.2.0 2021-05-10

1.1.3 2021-05-08

1.1.2 2021-05-06

1.1.1 2021-04-26

1.1.0 2021-04-24

1.0.0 2021-04-23

0.1.1 2021-04-04

0.1.0 2021-03-30