[](https://pypi.org/project/autodoc_pydantic/)
[](https://www.python.org/)
[](https://pypistats.org/packages/autodoc-pydantic)
[](https://github.com/mansenfranzen/autodoc_pydantic/actions)
[](https://app.codecov.io/gh/mansenfranzen/autodoc_pydantic)
[](https://autodoc-pydantic.readthedocs.io/en/stable/)
[](https://github.com/mansenfranzen/autodoc_pydantic/blob/main/LICENSE)
[](https://github.com/astral-sh/ruff)
[](https://github.com/python/mypy)<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
[](https://github.com/mansenfranzen/autodoc_pydantic?tab=readme-ov-file#-acknowledgements)
<!-- ALL-CONTRIBUTORS-BADGE:END -->
You love [pydantic](https://pydantic-docs.helpmanual.io/) β€ and you want to
document your models and configuration settings with [sphinx](https://www.sphinx-doc.org/en/master/)?
Perfect, let's go. But wait, sphinx' [autodoc](https://www.sphinx-doc.org/en/master/usage/extensions/autodoc.html)
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](https://autodoc-pydantic.readthedocs.io/en/stable/) | Guides and detailed information. |
| [π οΈ Installation](https://autodoc-pydantic.readthedocs.io/en/stable/users/installation.html) | Setup and installation procedures. |
| [π§ Configuration](https://autodoc-pydantic.readthedocs.io/en/stable/users/configuration.html) | System or application settings. |
| [π‘ Usage](https://autodoc-pydantic.readthedocs.io/en/stable/users/usage.html) | How to use the application or tool. |
| [π Examples](https://autodoc-pydantic.readthedocs.io/en/stable/users/examples.html) | Showcase and usage examples. |
| [π¨βπ» Developer Guide](https://autodoc-pydantic.readthedocs.io/en/stable/developers/setup.html) | In-depth guide for developers. |
# π Acknowledgements
Thanks to great open source projects [sphinx](https://www.sphinx-doc.org/en/master/),
[pydantic](https://pydantic-docs.helpmanual.io/) and
[poetry](https://python-poetry.org/) (and so many more) β€ in addition to the following contributors:
<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
<!-- prettier-ignore-start -->
<!-- markdownlint-disable -->
<table>
<tbody>
<tr>
<td align="center" valign="top" width="14.28%"><a href="https://github.com/mansenfranzen"><img src="https://avatars.githubusercontent.com/u/18086180?v=4?s=100" width="100px;" alt="Franz WΓΆllert"/><br /><sub><b>Franz WΓΆllert</b></sub></a><br /><a href="#maintenance-mansenfranzen" title="Maintenance">π§</a> <a href="https://github.com/mansenfranzen/autodoc_pydantic/commits?author=mansenfranzen" title="Documentation">π</a> <a href="https://github.com/mansenfranzen/autodoc_pydantic/commits?author=mansenfranzen" title="Tests">β οΈ</a> <a href="#content-mansenfranzen" title="Content">π</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://github.com/yves-renier"><img src="https://avatars.githubusercontent.com/u/102358016?v=4?s=100" width="100px;" alt="Yves Renier"/><br /><sub><b>Yves Renier</b></sub></a><br /><a href="https://github.com/mansenfranzen/autodoc_pydantic/commits?author=yves-renier" title="Documentation">π</a> <a href="https://github.com/mansenfranzen/autodoc_pydantic/commits?author=yves-renier" title="Tests">β οΈ</a> <a href="#content-yves-renier" title="Content">π</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://github.com/TheBeardedBerserkr"><img src="https://avatars.githubusercontent.com/u/32272268?v=4?s=100" width="100px;" alt="TheBeardedBerserkr"/><br /><sub><b>TheBeardedBerserkr</b></sub></a><br /><a href="#ideas-TheBeardedBerserkr" title="Ideas, Planning, & Feedback">π€</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://github.com/vlcinsky"><img src="https://avatars.githubusercontent.com/u/635911?v=4?s=100" width="100px;" alt="Jan VlΔinskΓ½"/><br /><sub><b>Jan VlΔinskΓ½</b></sub></a><br /><a href="#security-vlcinsky" title="Security">π‘οΈ</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://github.com/antvig"><img src="https://avatars.githubusercontent.com/u/25105210?v=4?s=100" width="100px;" alt="antvig"/><br /><sub><b>antvig</b></sub></a><br /><a href="https://github.com/mansenfranzen/autodoc_pydantic/issues?q=author%3Aantvig" title="Bug reports">π</a> <a href="#userTesting-antvig" title="User Testing">π</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://roguh.com"><img src="https://avatars.githubusercontent.com/u/6373447?v=4?s=100" width="100px;" alt="Hugo O Rivera"/><br /><sub><b>Hugo O Rivera</b></sub></a><br /><a href="#ideas-roguh" title="Ideas, Planning, & Feedback">π€</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://github.com/ybnd"><img src="https://avatars.githubusercontent.com/u/31547038?v=4?s=100" width="100px;" alt="yura bondarenko"/><br /><sub><b>yura bondarenko</b></sub></a><br /><a href="https://github.com/mansenfranzen/autodoc_pydantic/issues?q=author%3Aybnd" title="Bug reports">π</a> <a href="#userTesting-ybnd" title="User Testing">π</a></td>
</tr>
<tr>
<td align="center" valign="top" width="14.28%"><a href="http://tahoward.github.io"><img src="https://avatars.githubusercontent.com/u/547570?v=4?s=100" width="100px;" alt="Trevor Howard"/><br /><sub><b>Trevor Howard</b></sub></a><br /><a href="https://github.com/mansenfranzen/autodoc_pydantic/issues?q=author%3Atahoward" title="Bug reports">π</a> <a href="#userTesting-tahoward" title="User Testing">π</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://github.com/thomas-pedot"><img src="https://avatars.githubusercontent.com/u/86731212?v=4?s=100" width="100px;" alt="thomas-pedot"/><br /><sub><b>thomas-pedot</b></sub></a><br /><a href="https://github.com/mansenfranzen/autodoc_pydantic/issues?q=author%3Athomas-pedot" title="Bug reports">π</a> <a href="#userTesting-thomas-pedot" title="User Testing">π</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://github.com/matutter"><img src="https://avatars.githubusercontent.com/u/2701379?v=4?s=100" width="100px;" alt="Mat Utter"/><br /><sub><b>Mat Utter</b></sub></a><br /><a href="https://github.com/mansenfranzen/autodoc_pydantic/issues?q=author%3Amatutter" title="Bug reports">π</a> <a href="#userTesting-matutter" title="User Testing">π</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://github.com/davidchall"><img src="https://avatars.githubusercontent.com/u/1804856?v=4?s=100" width="100px;" alt="David C Hall"/><br /><sub><b>David C Hall</b></sub></a><br /><a href="#ideas-davidchall" title="Ideas, Planning, & Feedback">π€</a> <a href="#userTesting-davidchall" title="User Testing">π</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://yoshanuikabundi.me"><img src="https://avatars.githubusercontent.com/u/28590748?v=4?s=100" width="100px;" alt="Josh A. Mitchell"/><br /><sub><b>Josh A. Mitchell</b></sub></a><br /><a href="#ideas-Yoshanuikabundi" title="Ideas, Planning, & Feedback">π€</a> <a href="https://github.com/mansenfranzen/autodoc_pydantic/commits?author=Yoshanuikabundi" title="Tests">β οΈ</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://github.com/goroderickgo"><img src="https://avatars.githubusercontent.com/u/17296713?v=4?s=100" width="100px;" alt="Roderick Go"/><br /><sub><b>Roderick Go</b></sub></a><br /><a href="https://github.com/mansenfranzen/autodoc_pydantic/commits?author=goroderickgo" title="Tests">β οΈ</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://github.com/lilyminium"><img src="https://avatars.githubusercontent.com/u/31115101?v=4?s=100" width="100px;" alt="Lily Wang"/><br /><sub><b>Lily Wang</b></sub></a><br /><a href="https://github.com/mansenfranzen/autodoc_pydantic/commits?author=lilyminium" title="Documentation">π</a> <a href="#content-lilyminium" title="Content">π</a></td>
</tr>
<tr>
<td align="center" valign="top" width="14.28%"><a href="https://github.com/j-carson"><img src="https://avatars.githubusercontent.com/u/44308120?v=4?s=100" width="100px;" alt="j-carson"/><br /><sub><b>j-carson</b></sub></a><br /><a href="https://github.com/mansenfranzen/autodoc_pydantic/issues?q=author%3Aj-carson" title="Bug reports">π</a> <a href="https://github.com/mansenfranzen/autodoc_pydantic/commits?author=j-carson" title="Code">π»</a> <a href="https://github.com/mansenfranzen/autodoc_pydantic/commits?author=j-carson" title="Tests">β οΈ</a></td>
<td align="center" valign="top" width="14.28%"><a href="http://imada.sdu.dk/~jlandersen/"><img src="https://avatars.githubusercontent.com/u/6465735?v=4?s=100" width="100px;" alt="Jakob Lykke Andersen"/><br /><sub><b>Jakob Lykke Andersen</b></sub></a><br /><a href="https://github.com/mansenfranzen/autodoc_pydantic/commits?author=jakobandersen" title="Code">π»</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://github.com/astrojuanlu"><img src="https://avatars.githubusercontent.com/u/316517?v=4?s=100" width="100px;" alt="Juan Luis Cano RodrΓguez"/><br /><sub><b>Juan Luis Cano RodrΓguez</b></sub></a><br /><a href="#content-astrojuanlu" title="Content">π</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://github.com/nchaly"><img src="https://avatars.githubusercontent.com/u/2665273?v=4?s=100" width="100px;" alt="Mikalai Chaly"/><br /><sub><b>Mikalai Chaly</b></sub></a><br /><a href="https://github.com/mansenfranzen/autodoc_pydantic/issues?q=author%3Anchaly" title="Bug reports">π</a> <a href="https://github.com/mansenfranzen/autodoc_pydantic/commits?author=nchaly" title="Tests">β οΈ</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://github.com/StigKorsnes"><img src="https://avatars.githubusercontent.com/u/10085536?v=4?s=100" width="100px;" alt="Stig Korsnes"/><br /><sub><b>Stig Korsnes</b></sub></a><br /><a href="https://github.com/mansenfranzen/autodoc_pydantic/issues?q=author%3AStigKorsnes" title="Bug reports">π</a> <a href="#ideas-StigKorsnes" title="Ideas, Planning, & Feedback">π€</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://github.com/iliakur"><img src="https://avatars.githubusercontent.com/u/899591?v=4?s=100" width="100px;" alt="Ilia Kurenkov"/><br /><sub><b>Ilia Kurenkov</b></sub></a><br /><a href="https://github.com/mansenfranzen/autodoc_pydantic/issues?q=author%3Ailiakur" title="Bug reports">π</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://orcid.org/my-orcid?orcid=0000-0002-5470-1676"><img src="https://avatars.githubusercontent.com/u/3826210?v=4?s=100" width="100px;" alt="Grzegorz Bokota"/><br /><sub><b>Grzegorz Bokota</b></sub></a><br /><a href="https://github.com/mansenfranzen/autodoc_pydantic/issues?q=author%3ACzaki" title="Bug reports">π</a></td>
</tr>
<tr>
<td align="center" valign="top" width="14.28%"><a href="https://github.com/jgunstone"><img src="https://avatars.githubusercontent.com/u/21370980?v=4?s=100" width="100px;" alt="jgunstone"/><br /><sub><b>jgunstone</b></sub></a><br /><a href="https://github.com/mansenfranzen/autodoc_pydantic/issues?q=author%3Ajgunstone" title="Bug reports">π</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://github.com/iwyrkore"><img src="https://avatars.githubusercontent.com/u/92745880?v=4?s=100" width="100px;" alt="iwyrkore"/><br /><sub><b>iwyrkore</b></sub></a><br /><a href="https://github.com/mansenfranzen/autodoc_pydantic/commits?author=iwyrkore" title="Code">π»</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://github.com/spacemanspiff2007"><img src="https://avatars.githubusercontent.com/u/10754716?v=4?s=100" width="100px;" alt="spacemanspiff2007"/><br /><sub><b>spacemanspiff2007</b></sub></a><br /><a href="https://github.com/mansenfranzen/autodoc_pydantic/issues?q=author%3Aspacemanspiff2007" title="Bug reports">π</a> <a href="#ideas-spacemanspiff2007" title="Ideas, Planning, & Feedback">π€</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://luke.hsiao.dev"><img src="https://avatars.githubusercontent.com/u/7573542?v=4?s=100" width="100px;" alt="Luke Hsiao"/><br /><sub><b>Luke Hsiao</b></sub></a><br /><a href="https://github.com/mansenfranzen/autodoc_pydantic/issues?q=author%3Alukehsiao" title="Bug reports">π</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://github.com/nickeldan"><img src="https://avatars.githubusercontent.com/u/21210592?v=4?s=100" width="100px;" alt="Daniel Walker"/><br /><sub><b>Daniel Walker</b></sub></a><br /><a href="https://github.com/mansenfranzen/autodoc_pydantic/issues?q=author%3Anickeldan" title="Bug reports">π</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://t.me/pipeknight"><img src="https://avatars.githubusercontent.com/u/34810566?v=4?s=100" width="100px;" alt="Evgeniy Lupashin"/><br /><sub><b>Evgeniy Lupashin</b></sub></a><br /><a href="https://github.com/mansenfranzen/autodoc_pydantic/issues?q=author%3APipeKnight" title="Bug reports">π</a></td>
<td align="center" valign="top" width="14.28%"><a href="http://janhendrikewers.uk/"><img src="https://avatars.githubusercontent.com/u/12383029?v=4?s=100" width="100px;" alt="Jan-Hendrik Ewers"/><br /><sub><b>Jan-Hendrik Ewers</b></sub></a><br /><a href="https://github.com/mansenfranzen/autodoc_pydantic/issues?q=author%3Aiwishiwasaneagle" title="Bug reports">π</a></td>
</tr>
<tr>
<td align="center" valign="top" width="14.28%"><a href="https://jon-e.net"><img src="https://avatars.githubusercontent.com/u/12961499?v=4?s=100" width="100px;" alt="Jonny Saunders"/><br /><sub><b>Jonny Saunders</b></sub></a><br /><a href="https://github.com/mansenfranzen/autodoc_pydantic/issues?q=author%3Asneakers-the-rat" title="Bug reports">π</a></td>
<td align="center" valign="top" width="14.28%"><a href="http://charlie.machalow.com"><img src="https://avatars.githubusercontent.com/u/5749838?v=4?s=100" width="100px;" alt="Charles Machalow"/><br /><sub><b>Charles Machalow</b></sub></a><br /><a href="#question-csm10495" title="Answering Questions">π¬</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://github.com/tkaraouzene"><img src="https://avatars.githubusercontent.com/u/20064077?v=4?s=100" width="100px;" alt="Thomas Karaouzene"/><br /><sub><b>Thomas Karaouzene</b></sub></a><br /><a href="https://github.com/mansenfranzen/autodoc_pydantic/issues?q=author%3Atkaraouzene" title="Bug reports">π</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://github.com/caseyzak24"><img src="https://avatars.githubusercontent.com/u/29411281?v=4?s=100" width="100px;" alt="caseyzak24"/><br /><sub><b>caseyzak24</b></sub></a><br /><a href="https://github.com/mansenfranzen/autodoc_pydantic/commits?author=caseyzak24" title="Documentation">π</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://github.com/PriOliveira"><img src="https://avatars.githubusercontent.com/u/13801839?v=4?s=100" width="100px;" alt="Priscila Oliveira"/><br /><sub><b>Priscila Oliveira</b></sub></a><br /><a href="https://github.com/mansenfranzen/autodoc_pydantic/pulls?q=is%3Apr+reviewed-by%3APriOliveira" title="Reviewed Pull Requests">π</a> <a href="#userTesting-PriOliveira" title="User Testing">π</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://github.com/awoimbee"><img src="https://avatars.githubusercontent.com/u/22431493?v=4?s=100" width="100px;" alt="Arthur WoimbΓ©e"/><br /><sub><b>Arthur WoimbΓ©e</b></sub></a><br /><a href="https://github.com/mansenfranzen/autodoc_pydantic/pulls?q=is%3Apr+reviewed-by%3Aawoimbee" title="Reviewed Pull Requests">π</a> <a href="#userTesting-awoimbee" title="User Testing">π</a> <a href="https://github.com/mansenfranzen/autodoc_pydantic/commits?author=awoimbee" title="Code">π»</a> <a href="https://github.com/mansenfranzen/autodoc_pydantic/commits?author=awoimbee" title="Tests">β οΈ</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://github.com/effigies"><img src="https://avatars.githubusercontent.com/u/83442?v=4?s=100" width="100px;" alt="Chris Markiewicz"/><br /><sub><b>Chris Markiewicz</b></sub></a><br /><a href="https://github.com/mansenfranzen/autodoc_pydantic/issues?q=author%3Aeffigies" title="Bug reports">π</a></td>
</tr>
<tr>
<td align="center" valign="top" width="14.28%"><a href="https://github.com/nagledb"><img src="https://avatars.githubusercontent.com/u/727435?v=4?s=100" width="100px;" alt="David B. Nagle"/><br /><sub><b>David B. Nagle</b></sub></a><br /><a href="https://github.com/mansenfranzen/autodoc_pydantic/issues?q=author%3Anagledb" title="Bug reports">π</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://github.com/jerryjiahaha"><img src="https://avatars.githubusercontent.com/u/3163720?v=4?s=100" width="100px;" alt="JerryJia"/><br /><sub><b>JerryJia</b></sub></a><br /><a href="https://github.com/mansenfranzen/autodoc_pydantic/commits?author=jerryjiahaha" title="Code">π»</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://github.com/devmonkey22"><img src="https://avatars.githubusercontent.com/u/5084545?v=4?s=100" width="100px;" alt="Mike D"/><br /><sub><b>Mike D</b></sub></a><br /><a href="https://github.com/mansenfranzen/autodoc_pydantic/commits?author=devmonkey22" title="Code">π»</a> <a href="https://github.com/mansenfranzen/autodoc_pydantic/issues?q=author%3Adevmonkey22" title="Bug reports">π</a> <a href="https://github.com/mansenfranzen/autodoc_pydantic/commits?author=devmonkey22" title="Tests">β οΈ</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://github.com/daquinteroflex"><img src="https://avatars.githubusercontent.com/u/149674618?v=4?s=100" width="100px;" alt="Dario Quintero (Flexcompute)"/><br /><sub><b>Dario Quintero (Flexcompute)</b></sub></a><br /><a href="https://github.com/mansenfranzen/autodoc_pydantic/pulls?q=is%3Apr+reviewed-by%3Adaquinteroflex" title="Reviewed Pull Requests">π</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://github.com/rafa-guedes"><img src="https://avatars.githubusercontent.com/u/7799184?v=4?s=100" width="100px;" alt="Rafael Guedes"/><br /><sub><b>Rafael Guedes</b></sub></a><br /><a href="https://github.com/mansenfranzen/autodoc_pydantic/commits?author=rafa-guedes" title="Code">π»</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://github.com/caerulescens"><img src="https://avatars.githubusercontent.com/u/29284192?v=4?s=100" width="100px;" alt="Andrew Linzie"/><br /><sub><b>Andrew Linzie</b></sub></a><br /><a href="https://github.com/mansenfranzen/autodoc_pydantic/commits?author=caerulescens" title="Code">π»</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://github.com/tasansal"><img src="https://avatars.githubusercontent.com/u/13684161?v=4?s=100" width="100px;" alt="Altay Sansal"/><br /><sub><b>Altay Sansal</b></sub></a><br /><a href="#ideas-tasansal" title="Ideas, Planning, & Feedback">π€</a></td>
</tr>
<tr>
<td align="center" valign="top" width="14.28%"><a href="https://www.git-pull.com"><img src="https://avatars.githubusercontent.com/u/26336?v=4?s=100" width="100px;" alt="Tony Narlock"/><br /><sub><b>Tony Narlock</b></sub></a><br /><a href="https://github.com/mansenfranzen/autodoc_pydantic/commits?author=tony" title="Code">π»</a> <a href="https://github.com/mansenfranzen/autodoc_pydantic/commits?author=tony" title="Documentation">π</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://huxuan.org/"><img src="https://avatars.githubusercontent.com/u/726061?v=4?s=100" width="100px;" alt="Xuan (Sean) Hu"/><br /><sub><b>Xuan (Sean) Hu</b></sub></a><br /><a href="https://github.com/mansenfranzen/autodoc_pydantic/issues?q=author%3Ahuxuan" title="Bug reports">π</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://github.com/Cielquan"><img src="https://avatars.githubusercontent.com/u/43916661?v=4?s=100" width="100px;" alt="Christian Riedel"/><br /><sub><b>Christian Riedel</b></sub></a><br /><a href="https://github.com/mansenfranzen/autodoc_pydantic/issues?q=author%3ACielquan" title="Bug reports">π</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://github.com/morcef"><img src="https://avatars.githubusercontent.com/u/15701746?v=4?s=100" width="100px;" alt="morcef"/><br /><sub><b>morcef</b></sub></a><br /><a href="https://github.com/mansenfranzen/autodoc_pydantic/issues?q=author%3Amorcef" title="Bug reports">π</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://github.com/alejandro-yousef"><img src="https://avatars.githubusercontent.com/u/93203189?v=4?s=100" width="100px;" alt="alejandro-yousef"/><br /><sub><b>alejandro-yousef</b></sub></a><br /><a href="#ideas-alejandro-yousef" title="Ideas, Planning, & Feedback">π€</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://github.com/exs-dwoodward"><img src="https://avatars.githubusercontent.com/u/166007669?v=4?s=100" width="100px;" alt="exs-dwoodward"/><br /><sub><b>exs-dwoodward</b></sub></a><br /><a href="https://github.com/mansenfranzen/autodoc_pydantic/commits?author=exs-dwoodward" title="Code">π»</a></td>
<td align="center" valign="top" width="14.28%"><a href="http://www.leahwasser.com"><img src="https://avatars.githubusercontent.com/u/7649194?v=4?s=100" width="100px;" alt="Leah Wasser"/><br /><sub><b>Leah Wasser</b></sub></a><br /><a href="https://github.com/mansenfranzen/autodoc_pydantic/issues?q=author%3Alwasser" title="Bug reports">π</a></td>
</tr>
<tr>
<td align="center" valign="top" width="14.28%"><a href="https://galarzaa.com"><img src="https://avatars.githubusercontent.com/u/12865379?v=4?s=100" width="100px;" alt="Allan Galarza"/><br /><sub><b>Allan Galarza</b></sub></a><br /><a href="https://github.com/mansenfranzen/autodoc_pydantic/issues?q=author%3AGalarzaa90" title="Bug reports">π</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://github.com/Carson-Shaar"><img src="https://avatars.githubusercontent.com/u/120226019?v=4?s=100" width="100px;" alt="Carson-Shaar"/><br /><sub><b>Carson-Shaar</b></sub></a><br /><a href="https://github.com/mansenfranzen/autodoc_pydantic/issues?q=author%3ACarson-Shaar" title="Bug reports">π</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://linktr.ee/kyle.finley"><img src="https://avatars.githubusercontent.com/u/23145462?v=4?s=100" width="100px;" alt="Kyle Finley"/><br /><sub><b>Kyle Finley</b></sub></a><br /><a href="https://github.com/mansenfranzen/autodoc_pydantic/issues?q=author%3AITProKyle" title="Bug reports">π</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://github.com/bruno-f-cruz"><img src="https://avatars.githubusercontent.com/u/7049351?v=4?s=100" width="100px;" alt="brunocruz"/><br /><sub><b>brunocruz</b></sub></a><br /><a href="https://github.com/mansenfranzen/autodoc_pydantic/issues?q=author%3Abruno-f-cruz" title="Bug reports">π</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://github.com/AnneRademacher"><img src="https://avatars.githubusercontent.com/u/49472656?v=4?s=100" width="100px;" alt="Anne Rademacher"/><br /><sub><b>Anne Rademacher</b></sub></a><br /><a href="#financial-annerademacher" title="Financial">π΅</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://yaal.coop"><img src="https://avatars.githubusercontent.com/u/60163?v=4?s=100" width="100px;" alt="Γloi Rivard"/><br /><sub><b>Γloi Rivard</b></sub></a><br /><a href="https://github.com/mansenfranzen/autodoc_pydantic/issues?q=author%3Aazmeuk" title="Bug reports">π</a></td>
</tr>
</tbody>
</table>
<!-- markdownlint-restore -->
<!-- prettier-ignore-end -->
<!-- ALL-CONTRIBUTORS-LIST:END -->
This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!
Raw data
{
"_id": null,
"home_page": "https://github.com/mansenfranzen/autodoc_pydantic",
"name": "autodoc_pydantic",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0.0,>=3.8.1",
"maintainer_email": null,
"keywords": "sphinx, pydantic, autodoc, documentation, extension",
"author": "mansenfranzen",
"author_email": "franz.woellert@gmail.com",
"download_url": null,
"platform": null,
"description": "\n\n[](https://pypi.org/project/autodoc_pydantic/)\n[](https://www.python.org/)\n[](https://pypistats.org/packages/autodoc-pydantic)\n\n[](https://github.com/mansenfranzen/autodoc_pydantic/actions)\n[](https://app.codecov.io/gh/mansenfranzen/autodoc_pydantic)\n[](https://autodoc-pydantic.readthedocs.io/en/stable/)\n\n[](https://github.com/mansenfranzen/autodoc_pydantic/blob/main/LICENSE)\n[](https://github.com/astral-sh/ruff)\n[](https://github.com/python/mypy)<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->\n[](https://github.com/mansenfranzen/autodoc_pydantic?tab=readme-ov-file#-acknowledgements)\n<!-- ALL-CONTRIBUTORS-BADGE:END -->\n\n\nYou love [pydantic](https://pydantic-docs.helpmanual.io/) \u2764 and you want to\ndocument your models and configuration settings with [sphinx](https://www.sphinx-doc.org/en/master/)?\n\nPerfect, let's go. But wait, sphinx' [autodoc](https://www.sphinx-doc.org/en/master/usage/extensions/autodoc.html)\ndoes not integrate too well with pydantic models \ud83d\ude15.\n\nDon't worry - just `pip install autodoc_pydantic` \u263a.\n\n# \ud83c\udf1f Features\n\n- \ud83d\udcac provides default values, alias and constraints for model fields\n- \ud83d\udd17 adds hyperlinks between validators and corresponding fields\n- \ud83d\udcc3 includes collapsable model json schema\n- \ud83c\udfc4 natively integrates with autodoc and autosummary extensions\n- \ud83d\udcce defines explicit pydantic prefixes for models, settings, fields, validators and model config\n- \ud83d\udccb shows summary section for model configuration, fields and validators\n- \ud83d\udc40 hides overloaded and redundant model class signature\n- \ud83d\udd31 visualizes entity-relationship-diagrams for class hierarchies\n- \ud83d\udd28 allows complete configurability on global and per-model level\n- \ud83c\udf40 supports `pydantic >= 1.5.0` and `sphinx >= 4.0.0`\n\n# \ud83d\udcc4 Documentation\n\n| Section | Description |\n|-----------------------------------------|-----------------------------------------|\n| [\ud83d\udcd1 Landing Page](https://autodoc-pydantic.readthedocs.io/en/stable/) | Guides and detailed information. |\n| [\ud83d\udee0\ufe0f Installation](https://autodoc-pydantic.readthedocs.io/en/stable/users/installation.html) | Setup and installation procedures. |\n| [\ud83d\udd27 Configuration](https://autodoc-pydantic.readthedocs.io/en/stable/users/configuration.html) | System or application settings. |\n| [\ud83d\udca1 Usage](https://autodoc-pydantic.readthedocs.io/en/stable/users/usage.html) | How to use the application or tool. |\n| [\ud83c\udf10 Examples](https://autodoc-pydantic.readthedocs.io/en/stable/users/examples.html) | Showcase and usage examples. |\n| [\ud83d\udc68\u200d\ud83d\udcbb Developer Guide](https://autodoc-pydantic.readthedocs.io/en/stable/developers/setup.html) | In-depth guide for developers. |\n\n\n# \ud83d\ude4f Acknowledgements\n\nThanks to great open source projects [sphinx](https://www.sphinx-doc.org/en/master/),\n[pydantic](https://pydantic-docs.helpmanual.io/) and\n[poetry](https://python-poetry.org/) (and so many more) \u2764 in addition to the following contributors:\n\n<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->\n<!-- prettier-ignore-start -->\n<!-- markdownlint-disable -->\n<table>\n <tbody>\n <tr>\n <td align=\"center\" valign=\"top\" width=\"14.28%\"><a href=\"https://github.com/mansenfranzen\"><img src=\"https://avatars.githubusercontent.com/u/18086180?v=4?s=100\" width=\"100px;\" alt=\"Franz W\u00f6llert\"/><br /><sub><b>Franz W\u00f6llert</b></sub></a><br /><a href=\"#maintenance-mansenfranzen\" title=\"Maintenance\">\ud83d\udea7</a> <a href=\"https://github.com/mansenfranzen/autodoc_pydantic/commits?author=mansenfranzen\" title=\"Documentation\">\ud83d\udcd6</a> <a href=\"https://github.com/mansenfranzen/autodoc_pydantic/commits?author=mansenfranzen\" title=\"Tests\">\u26a0\ufe0f</a> <a href=\"#content-mansenfranzen\" title=\"Content\">\ud83d\udd8b</a></td>\n <td align=\"center\" valign=\"top\" width=\"14.28%\"><a href=\"https://github.com/yves-renier\"><img src=\"https://avatars.githubusercontent.com/u/102358016?v=4?s=100\" width=\"100px;\" alt=\"Yves Renier\"/><br /><sub><b>Yves Renier</b></sub></a><br /><a href=\"https://github.com/mansenfranzen/autodoc_pydantic/commits?author=yves-renier\" title=\"Documentation\">\ud83d\udcd6</a> <a href=\"https://github.com/mansenfranzen/autodoc_pydantic/commits?author=yves-renier\" title=\"Tests\">\u26a0\ufe0f</a> <a href=\"#content-yves-renier\" title=\"Content\">\ud83d\udd8b</a></td>\n <td align=\"center\" valign=\"top\" width=\"14.28%\"><a href=\"https://github.com/TheBeardedBerserkr\"><img src=\"https://avatars.githubusercontent.com/u/32272268?v=4?s=100\" width=\"100px;\" alt=\"TheBeardedBerserkr\"/><br /><sub><b>TheBeardedBerserkr</b></sub></a><br /><a href=\"#ideas-TheBeardedBerserkr\" title=\"Ideas, Planning, & Feedback\">\ud83e\udd14</a></td>\n <td align=\"center\" valign=\"top\" width=\"14.28%\"><a href=\"https://github.com/vlcinsky\"><img src=\"https://avatars.githubusercontent.com/u/635911?v=4?s=100\" width=\"100px;\" alt=\"Jan Vl\u010dinsk\u00fd\"/><br /><sub><b>Jan Vl\u010dinsk\u00fd</b></sub></a><br /><a href=\"#security-vlcinsky\" title=\"Security\">\ud83d\udee1\ufe0f</a></td>\n <td align=\"center\" valign=\"top\" width=\"14.28%\"><a href=\"https://github.com/antvig\"><img src=\"https://avatars.githubusercontent.com/u/25105210?v=4?s=100\" width=\"100px;\" alt=\"antvig\"/><br /><sub><b>antvig</b></sub></a><br /><a href=\"https://github.com/mansenfranzen/autodoc_pydantic/issues?q=author%3Aantvig\" title=\"Bug reports\">\ud83d\udc1b</a> <a href=\"#userTesting-antvig\" title=\"User Testing\">\ud83d\udcd3</a></td>\n <td align=\"center\" valign=\"top\" width=\"14.28%\"><a href=\"https://roguh.com\"><img src=\"https://avatars.githubusercontent.com/u/6373447?v=4?s=100\" width=\"100px;\" alt=\"Hugo O Rivera\"/><br /><sub><b>Hugo O Rivera</b></sub></a><br /><a href=\"#ideas-roguh\" title=\"Ideas, Planning, & Feedback\">\ud83e\udd14</a></td>\n <td align=\"center\" valign=\"top\" width=\"14.28%\"><a href=\"https://github.com/ybnd\"><img src=\"https://avatars.githubusercontent.com/u/31547038?v=4?s=100\" width=\"100px;\" alt=\"yura bondarenko\"/><br /><sub><b>yura bondarenko</b></sub></a><br /><a href=\"https://github.com/mansenfranzen/autodoc_pydantic/issues?q=author%3Aybnd\" title=\"Bug reports\">\ud83d\udc1b</a> <a href=\"#userTesting-ybnd\" title=\"User Testing\">\ud83d\udcd3</a></td>\n </tr>\n <tr>\n <td align=\"center\" valign=\"top\" width=\"14.28%\"><a href=\"http://tahoward.github.io\"><img src=\"https://avatars.githubusercontent.com/u/547570?v=4?s=100\" width=\"100px;\" alt=\"Trevor Howard\"/><br /><sub><b>Trevor Howard</b></sub></a><br /><a href=\"https://github.com/mansenfranzen/autodoc_pydantic/issues?q=author%3Atahoward\" title=\"Bug reports\">\ud83d\udc1b</a> <a href=\"#userTesting-tahoward\" title=\"User Testing\">\ud83d\udcd3</a></td>\n <td align=\"center\" valign=\"top\" width=\"14.28%\"><a href=\"https://github.com/thomas-pedot\"><img src=\"https://avatars.githubusercontent.com/u/86731212?v=4?s=100\" width=\"100px;\" alt=\"thomas-pedot\"/><br /><sub><b>thomas-pedot</b></sub></a><br /><a href=\"https://github.com/mansenfranzen/autodoc_pydantic/issues?q=author%3Athomas-pedot\" title=\"Bug reports\">\ud83d\udc1b</a> <a href=\"#userTesting-thomas-pedot\" title=\"User Testing\">\ud83d\udcd3</a></td>\n <td align=\"center\" valign=\"top\" width=\"14.28%\"><a href=\"https://github.com/matutter\"><img src=\"https://avatars.githubusercontent.com/u/2701379?v=4?s=100\" width=\"100px;\" alt=\"Mat Utter\"/><br /><sub><b>Mat Utter</b></sub></a><br /><a href=\"https://github.com/mansenfranzen/autodoc_pydantic/issues?q=author%3Amatutter\" title=\"Bug reports\">\ud83d\udc1b</a> <a href=\"#userTesting-matutter\" title=\"User Testing\">\ud83d\udcd3</a></td>\n <td align=\"center\" valign=\"top\" width=\"14.28%\"><a href=\"https://github.com/davidchall\"><img src=\"https://avatars.githubusercontent.com/u/1804856?v=4?s=100\" width=\"100px;\" alt=\"David C Hall\"/><br /><sub><b>David C Hall</b></sub></a><br /><a href=\"#ideas-davidchall\" title=\"Ideas, Planning, & Feedback\">\ud83e\udd14</a> <a href=\"#userTesting-davidchall\" title=\"User Testing\">\ud83d\udcd3</a></td>\n <td align=\"center\" valign=\"top\" width=\"14.28%\"><a href=\"https://yoshanuikabundi.me\"><img src=\"https://avatars.githubusercontent.com/u/28590748?v=4?s=100\" width=\"100px;\" alt=\"Josh A. Mitchell\"/><br /><sub><b>Josh A. Mitchell</b></sub></a><br /><a href=\"#ideas-Yoshanuikabundi\" title=\"Ideas, Planning, & Feedback\">\ud83e\udd14</a> <a href=\"https://github.com/mansenfranzen/autodoc_pydantic/commits?author=Yoshanuikabundi\" title=\"Tests\">\u26a0\ufe0f</a></td>\n <td align=\"center\" valign=\"top\" width=\"14.28%\"><a href=\"https://github.com/goroderickgo\"><img src=\"https://avatars.githubusercontent.com/u/17296713?v=4?s=100\" width=\"100px;\" alt=\"Roderick Go\"/><br /><sub><b>Roderick Go</b></sub></a><br /><a href=\"https://github.com/mansenfranzen/autodoc_pydantic/commits?author=goroderickgo\" title=\"Tests\">\u26a0\ufe0f</a></td>\n <td align=\"center\" valign=\"top\" width=\"14.28%\"><a href=\"https://github.com/lilyminium\"><img src=\"https://avatars.githubusercontent.com/u/31115101?v=4?s=100\" width=\"100px;\" alt=\"Lily Wang\"/><br /><sub><b>Lily Wang</b></sub></a><br /><a href=\"https://github.com/mansenfranzen/autodoc_pydantic/commits?author=lilyminium\" title=\"Documentation\">\ud83d\udcd6</a> <a href=\"#content-lilyminium\" title=\"Content\">\ud83d\udd8b</a></td>\n </tr>\n <tr>\n <td align=\"center\" valign=\"top\" width=\"14.28%\"><a href=\"https://github.com/j-carson\"><img src=\"https://avatars.githubusercontent.com/u/44308120?v=4?s=100\" width=\"100px;\" alt=\"j-carson\"/><br /><sub><b>j-carson</b></sub></a><br /><a href=\"https://github.com/mansenfranzen/autodoc_pydantic/issues?q=author%3Aj-carson\" title=\"Bug reports\">\ud83d\udc1b</a> <a href=\"https://github.com/mansenfranzen/autodoc_pydantic/commits?author=j-carson\" title=\"Code\">\ud83d\udcbb</a> <a href=\"https://github.com/mansenfranzen/autodoc_pydantic/commits?author=j-carson\" title=\"Tests\">\u26a0\ufe0f</a></td>\n <td align=\"center\" valign=\"top\" width=\"14.28%\"><a href=\"http://imada.sdu.dk/~jlandersen/\"><img src=\"https://avatars.githubusercontent.com/u/6465735?v=4?s=100\" width=\"100px;\" alt=\"Jakob Lykke Andersen\"/><br /><sub><b>Jakob Lykke Andersen</b></sub></a><br /><a href=\"https://github.com/mansenfranzen/autodoc_pydantic/commits?author=jakobandersen\" title=\"Code\">\ud83d\udcbb</a></td>\n <td align=\"center\" valign=\"top\" width=\"14.28%\"><a href=\"https://github.com/astrojuanlu\"><img src=\"https://avatars.githubusercontent.com/u/316517?v=4?s=100\" width=\"100px;\" alt=\"Juan Luis Cano Rodr\u00edguez\"/><br /><sub><b>Juan Luis Cano Rodr\u00edguez</b></sub></a><br /><a href=\"#content-astrojuanlu\" title=\"Content\">\ud83d\udd8b</a></td>\n <td align=\"center\" valign=\"top\" width=\"14.28%\"><a href=\"https://github.com/nchaly\"><img src=\"https://avatars.githubusercontent.com/u/2665273?v=4?s=100\" width=\"100px;\" alt=\"Mikalai Chaly\"/><br /><sub><b>Mikalai Chaly</b></sub></a><br /><a href=\"https://github.com/mansenfranzen/autodoc_pydantic/issues?q=author%3Anchaly\" title=\"Bug reports\">\ud83d\udc1b</a> <a href=\"https://github.com/mansenfranzen/autodoc_pydantic/commits?author=nchaly\" title=\"Tests\">\u26a0\ufe0f</a></td>\n <td align=\"center\" valign=\"top\" width=\"14.28%\"><a href=\"https://github.com/StigKorsnes\"><img src=\"https://avatars.githubusercontent.com/u/10085536?v=4?s=100\" width=\"100px;\" alt=\"Stig Korsnes\"/><br /><sub><b>Stig Korsnes</b></sub></a><br /><a href=\"https://github.com/mansenfranzen/autodoc_pydantic/issues?q=author%3AStigKorsnes\" title=\"Bug reports\">\ud83d\udc1b</a> <a href=\"#ideas-StigKorsnes\" title=\"Ideas, Planning, & Feedback\">\ud83e\udd14</a></td>\n <td align=\"center\" valign=\"top\" width=\"14.28%\"><a href=\"https://github.com/iliakur\"><img src=\"https://avatars.githubusercontent.com/u/899591?v=4?s=100\" width=\"100px;\" alt=\"Ilia Kurenkov\"/><br /><sub><b>Ilia Kurenkov</b></sub></a><br /><a href=\"https://github.com/mansenfranzen/autodoc_pydantic/issues?q=author%3Ailiakur\" title=\"Bug reports\">\ud83d\udc1b</a></td>\n <td align=\"center\" valign=\"top\" width=\"14.28%\"><a href=\"https://orcid.org/my-orcid?orcid=0000-0002-5470-1676\"><img src=\"https://avatars.githubusercontent.com/u/3826210?v=4?s=100\" width=\"100px;\" alt=\"Grzegorz Bokota\"/><br /><sub><b>Grzegorz Bokota</b></sub></a><br /><a href=\"https://github.com/mansenfranzen/autodoc_pydantic/issues?q=author%3ACzaki\" title=\"Bug reports\">\ud83d\udc1b</a></td>\n </tr>\n <tr>\n <td align=\"center\" valign=\"top\" width=\"14.28%\"><a href=\"https://github.com/jgunstone\"><img src=\"https://avatars.githubusercontent.com/u/21370980?v=4?s=100\" width=\"100px;\" alt=\"jgunstone\"/><br /><sub><b>jgunstone</b></sub></a><br /><a href=\"https://github.com/mansenfranzen/autodoc_pydantic/issues?q=author%3Ajgunstone\" title=\"Bug reports\">\ud83d\udc1b</a></td>\n <td align=\"center\" valign=\"top\" width=\"14.28%\"><a href=\"https://github.com/iwyrkore\"><img src=\"https://avatars.githubusercontent.com/u/92745880?v=4?s=100\" width=\"100px;\" alt=\"iwyrkore\"/><br /><sub><b>iwyrkore</b></sub></a><br /><a href=\"https://github.com/mansenfranzen/autodoc_pydantic/commits?author=iwyrkore\" title=\"Code\">\ud83d\udcbb</a></td>\n <td align=\"center\" valign=\"top\" width=\"14.28%\"><a href=\"https://github.com/spacemanspiff2007\"><img src=\"https://avatars.githubusercontent.com/u/10754716?v=4?s=100\" width=\"100px;\" alt=\"spacemanspiff2007\"/><br /><sub><b>spacemanspiff2007</b></sub></a><br /><a href=\"https://github.com/mansenfranzen/autodoc_pydantic/issues?q=author%3Aspacemanspiff2007\" title=\"Bug reports\">\ud83d\udc1b</a> <a href=\"#ideas-spacemanspiff2007\" title=\"Ideas, Planning, & Feedback\">\ud83e\udd14</a></td>\n <td align=\"center\" valign=\"top\" width=\"14.28%\"><a href=\"https://luke.hsiao.dev\"><img src=\"https://avatars.githubusercontent.com/u/7573542?v=4?s=100\" width=\"100px;\" alt=\"Luke Hsiao\"/><br /><sub><b>Luke Hsiao</b></sub></a><br /><a href=\"https://github.com/mansenfranzen/autodoc_pydantic/issues?q=author%3Alukehsiao\" title=\"Bug reports\">\ud83d\udc1b</a></td>\n <td align=\"center\" valign=\"top\" width=\"14.28%\"><a href=\"https://github.com/nickeldan\"><img src=\"https://avatars.githubusercontent.com/u/21210592?v=4?s=100\" width=\"100px;\" alt=\"Daniel Walker\"/><br /><sub><b>Daniel Walker</b></sub></a><br /><a href=\"https://github.com/mansenfranzen/autodoc_pydantic/issues?q=author%3Anickeldan\" title=\"Bug reports\">\ud83d\udc1b</a></td>\n <td align=\"center\" valign=\"top\" width=\"14.28%\"><a href=\"https://t.me/pipeknight\"><img src=\"https://avatars.githubusercontent.com/u/34810566?v=4?s=100\" width=\"100px;\" alt=\"Evgeniy Lupashin\"/><br /><sub><b>Evgeniy Lupashin</b></sub></a><br /><a href=\"https://github.com/mansenfranzen/autodoc_pydantic/issues?q=author%3APipeKnight\" title=\"Bug reports\">\ud83d\udc1b</a></td>\n <td align=\"center\" valign=\"top\" width=\"14.28%\"><a href=\"http://janhendrikewers.uk/\"><img src=\"https://avatars.githubusercontent.com/u/12383029?v=4?s=100\" width=\"100px;\" alt=\"Jan-Hendrik Ewers\"/><br /><sub><b>Jan-Hendrik Ewers</b></sub></a><br /><a href=\"https://github.com/mansenfranzen/autodoc_pydantic/issues?q=author%3Aiwishiwasaneagle\" title=\"Bug reports\">\ud83d\udc1b</a></td>\n </tr>\n <tr>\n <td align=\"center\" valign=\"top\" width=\"14.28%\"><a href=\"https://jon-e.net\"><img src=\"https://avatars.githubusercontent.com/u/12961499?v=4?s=100\" width=\"100px;\" alt=\"Jonny Saunders\"/><br /><sub><b>Jonny Saunders</b></sub></a><br /><a href=\"https://github.com/mansenfranzen/autodoc_pydantic/issues?q=author%3Asneakers-the-rat\" title=\"Bug reports\">\ud83d\udc1b</a></td>\n <td align=\"center\" valign=\"top\" width=\"14.28%\"><a href=\"http://charlie.machalow.com\"><img src=\"https://avatars.githubusercontent.com/u/5749838?v=4?s=100\" width=\"100px;\" alt=\"Charles Machalow\"/><br /><sub><b>Charles Machalow</b></sub></a><br /><a href=\"#question-csm10495\" title=\"Answering Questions\">\ud83d\udcac</a></td>\n <td align=\"center\" valign=\"top\" width=\"14.28%\"><a href=\"https://github.com/tkaraouzene\"><img src=\"https://avatars.githubusercontent.com/u/20064077?v=4?s=100\" width=\"100px;\" alt=\"Thomas Karaouzene\"/><br /><sub><b>Thomas Karaouzene</b></sub></a><br /><a href=\"https://github.com/mansenfranzen/autodoc_pydantic/issues?q=author%3Atkaraouzene\" title=\"Bug reports\">\ud83d\udc1b</a></td>\n <td align=\"center\" valign=\"top\" width=\"14.28%\"><a href=\"https://github.com/caseyzak24\"><img src=\"https://avatars.githubusercontent.com/u/29411281?v=4?s=100\" width=\"100px;\" alt=\"caseyzak24\"/><br /><sub><b>caseyzak24</b></sub></a><br /><a href=\"https://github.com/mansenfranzen/autodoc_pydantic/commits?author=caseyzak24\" title=\"Documentation\">\ud83d\udcd6</a></td>\n <td align=\"center\" valign=\"top\" width=\"14.28%\"><a href=\"https://github.com/PriOliveira\"><img src=\"https://avatars.githubusercontent.com/u/13801839?v=4?s=100\" width=\"100px;\" alt=\"Priscila Oliveira\"/><br /><sub><b>Priscila Oliveira</b></sub></a><br /><a href=\"https://github.com/mansenfranzen/autodoc_pydantic/pulls?q=is%3Apr+reviewed-by%3APriOliveira\" title=\"Reviewed Pull Requests\">\ud83d\udc40</a> <a href=\"#userTesting-PriOliveira\" title=\"User Testing\">\ud83d\udcd3</a></td>\n <td align=\"center\" valign=\"top\" width=\"14.28%\"><a href=\"https://github.com/awoimbee\"><img src=\"https://avatars.githubusercontent.com/u/22431493?v=4?s=100\" width=\"100px;\" alt=\"Arthur Woimb\u00e9e\"/><br /><sub><b>Arthur Woimb\u00e9e</b></sub></a><br /><a href=\"https://github.com/mansenfranzen/autodoc_pydantic/pulls?q=is%3Apr+reviewed-by%3Aawoimbee\" title=\"Reviewed Pull Requests\">\ud83d\udc40</a> <a href=\"#userTesting-awoimbee\" title=\"User Testing\">\ud83d\udcd3</a> <a href=\"https://github.com/mansenfranzen/autodoc_pydantic/commits?author=awoimbee\" title=\"Code\">\ud83d\udcbb</a> <a href=\"https://github.com/mansenfranzen/autodoc_pydantic/commits?author=awoimbee\" title=\"Tests\">\u26a0\ufe0f</a></td>\n <td align=\"center\" valign=\"top\" width=\"14.28%\"><a href=\"https://github.com/effigies\"><img src=\"https://avatars.githubusercontent.com/u/83442?v=4?s=100\" width=\"100px;\" alt=\"Chris Markiewicz\"/><br /><sub><b>Chris Markiewicz</b></sub></a><br /><a href=\"https://github.com/mansenfranzen/autodoc_pydantic/issues?q=author%3Aeffigies\" title=\"Bug reports\">\ud83d\udc1b</a></td>\n </tr>\n <tr>\n <td align=\"center\" valign=\"top\" width=\"14.28%\"><a href=\"https://github.com/nagledb\"><img src=\"https://avatars.githubusercontent.com/u/727435?v=4?s=100\" width=\"100px;\" alt=\"David B. Nagle\"/><br /><sub><b>David B. Nagle</b></sub></a><br /><a href=\"https://github.com/mansenfranzen/autodoc_pydantic/issues?q=author%3Anagledb\" title=\"Bug reports\">\ud83d\udc1b</a></td>\n <td align=\"center\" valign=\"top\" width=\"14.28%\"><a href=\"https://github.com/jerryjiahaha\"><img src=\"https://avatars.githubusercontent.com/u/3163720?v=4?s=100\" width=\"100px;\" alt=\"JerryJia\"/><br /><sub><b>JerryJia</b></sub></a><br /><a href=\"https://github.com/mansenfranzen/autodoc_pydantic/commits?author=jerryjiahaha\" title=\"Code\">\ud83d\udcbb</a></td>\n <td align=\"center\" valign=\"top\" width=\"14.28%\"><a href=\"https://github.com/devmonkey22\"><img src=\"https://avatars.githubusercontent.com/u/5084545?v=4?s=100\" width=\"100px;\" alt=\"Mike D\"/><br /><sub><b>Mike D</b></sub></a><br /><a href=\"https://github.com/mansenfranzen/autodoc_pydantic/commits?author=devmonkey22\" title=\"Code\">\ud83d\udcbb</a> <a href=\"https://github.com/mansenfranzen/autodoc_pydantic/issues?q=author%3Adevmonkey22\" title=\"Bug reports\">\ud83d\udc1b</a> <a href=\"https://github.com/mansenfranzen/autodoc_pydantic/commits?author=devmonkey22\" title=\"Tests\">\u26a0\ufe0f</a></td>\n <td align=\"center\" valign=\"top\" width=\"14.28%\"><a href=\"https://github.com/daquinteroflex\"><img src=\"https://avatars.githubusercontent.com/u/149674618?v=4?s=100\" width=\"100px;\" alt=\"Dario Quintero (Flexcompute)\"/><br /><sub><b>Dario Quintero (Flexcompute)</b></sub></a><br /><a href=\"https://github.com/mansenfranzen/autodoc_pydantic/pulls?q=is%3Apr+reviewed-by%3Adaquinteroflex\" title=\"Reviewed Pull Requests\">\ud83d\udc40</a></td>\n <td align=\"center\" valign=\"top\" width=\"14.28%\"><a href=\"https://github.com/rafa-guedes\"><img src=\"https://avatars.githubusercontent.com/u/7799184?v=4?s=100\" width=\"100px;\" alt=\"Rafael Guedes\"/><br /><sub><b>Rafael Guedes</b></sub></a><br /><a href=\"https://github.com/mansenfranzen/autodoc_pydantic/commits?author=rafa-guedes\" title=\"Code\">\ud83d\udcbb</a></td>\n <td align=\"center\" valign=\"top\" width=\"14.28%\"><a href=\"https://github.com/caerulescens\"><img src=\"https://avatars.githubusercontent.com/u/29284192?v=4?s=100\" width=\"100px;\" alt=\"Andrew Linzie\"/><br /><sub><b>Andrew Linzie</b></sub></a><br /><a href=\"https://github.com/mansenfranzen/autodoc_pydantic/commits?author=caerulescens\" title=\"Code\">\ud83d\udcbb</a></td>\n <td align=\"center\" valign=\"top\" width=\"14.28%\"><a href=\"https://github.com/tasansal\"><img src=\"https://avatars.githubusercontent.com/u/13684161?v=4?s=100\" width=\"100px;\" alt=\"Altay Sansal\"/><br /><sub><b>Altay Sansal</b></sub></a><br /><a href=\"#ideas-tasansal\" title=\"Ideas, Planning, & Feedback\">\ud83e\udd14</a></td>\n </tr>\n <tr>\n <td align=\"center\" valign=\"top\" width=\"14.28%\"><a href=\"https://www.git-pull.com\"><img src=\"https://avatars.githubusercontent.com/u/26336?v=4?s=100\" width=\"100px;\" alt=\"Tony Narlock\"/><br /><sub><b>Tony Narlock</b></sub></a><br /><a href=\"https://github.com/mansenfranzen/autodoc_pydantic/commits?author=tony\" title=\"Code\">\ud83d\udcbb</a> <a href=\"https://github.com/mansenfranzen/autodoc_pydantic/commits?author=tony\" title=\"Documentation\">\ud83d\udcd6</a></td>\n <td align=\"center\" valign=\"top\" width=\"14.28%\"><a href=\"https://huxuan.org/\"><img src=\"https://avatars.githubusercontent.com/u/726061?v=4?s=100\" width=\"100px;\" alt=\"Xuan (Sean) Hu\"/><br /><sub><b>Xuan (Sean) Hu</b></sub></a><br /><a href=\"https://github.com/mansenfranzen/autodoc_pydantic/issues?q=author%3Ahuxuan\" title=\"Bug reports\">\ud83d\udc1b</a></td>\n <td align=\"center\" valign=\"top\" width=\"14.28%\"><a href=\"https://github.com/Cielquan\"><img src=\"https://avatars.githubusercontent.com/u/43916661?v=4?s=100\" width=\"100px;\" alt=\"Christian Riedel\"/><br /><sub><b>Christian Riedel</b></sub></a><br /><a href=\"https://github.com/mansenfranzen/autodoc_pydantic/issues?q=author%3ACielquan\" title=\"Bug reports\">\ud83d\udc1b</a></td>\n <td align=\"center\" valign=\"top\" width=\"14.28%\"><a href=\"https://github.com/morcef\"><img src=\"https://avatars.githubusercontent.com/u/15701746?v=4?s=100\" width=\"100px;\" alt=\"morcef\"/><br /><sub><b>morcef</b></sub></a><br /><a href=\"https://github.com/mansenfranzen/autodoc_pydantic/issues?q=author%3Amorcef\" title=\"Bug reports\">\ud83d\udc1b</a></td>\n <td align=\"center\" valign=\"top\" width=\"14.28%\"><a href=\"https://github.com/alejandro-yousef\"><img src=\"https://avatars.githubusercontent.com/u/93203189?v=4?s=100\" width=\"100px;\" alt=\"alejandro-yousef\"/><br /><sub><b>alejandro-yousef</b></sub></a><br /><a href=\"#ideas-alejandro-yousef\" title=\"Ideas, Planning, & Feedback\">\ud83e\udd14</a></td>\n <td align=\"center\" valign=\"top\" width=\"14.28%\"><a href=\"https://github.com/exs-dwoodward\"><img src=\"https://avatars.githubusercontent.com/u/166007669?v=4?s=100\" width=\"100px;\" alt=\"exs-dwoodward\"/><br /><sub><b>exs-dwoodward</b></sub></a><br /><a href=\"https://github.com/mansenfranzen/autodoc_pydantic/commits?author=exs-dwoodward\" title=\"Code\">\ud83d\udcbb</a></td>\n <td align=\"center\" valign=\"top\" width=\"14.28%\"><a href=\"http://www.leahwasser.com\"><img src=\"https://avatars.githubusercontent.com/u/7649194?v=4?s=100\" width=\"100px;\" alt=\"Leah Wasser\"/><br /><sub><b>Leah Wasser</b></sub></a><br /><a href=\"https://github.com/mansenfranzen/autodoc_pydantic/issues?q=author%3Alwasser\" title=\"Bug reports\">\ud83d\udc1b</a></td>\n </tr>\n <tr>\n <td align=\"center\" valign=\"top\" width=\"14.28%\"><a href=\"https://galarzaa.com\"><img src=\"https://avatars.githubusercontent.com/u/12865379?v=4?s=100\" width=\"100px;\" alt=\"Allan Galarza\"/><br /><sub><b>Allan Galarza</b></sub></a><br /><a href=\"https://github.com/mansenfranzen/autodoc_pydantic/issues?q=author%3AGalarzaa90\" title=\"Bug reports\">\ud83d\udc1b</a></td>\n <td align=\"center\" valign=\"top\" width=\"14.28%\"><a href=\"https://github.com/Carson-Shaar\"><img src=\"https://avatars.githubusercontent.com/u/120226019?v=4?s=100\" width=\"100px;\" alt=\"Carson-Shaar\"/><br /><sub><b>Carson-Shaar</b></sub></a><br /><a href=\"https://github.com/mansenfranzen/autodoc_pydantic/issues?q=author%3ACarson-Shaar\" title=\"Bug reports\">\ud83d\udc1b</a></td>\n <td align=\"center\" valign=\"top\" width=\"14.28%\"><a href=\"https://linktr.ee/kyle.finley\"><img src=\"https://avatars.githubusercontent.com/u/23145462?v=4?s=100\" width=\"100px;\" alt=\"Kyle Finley\"/><br /><sub><b>Kyle Finley</b></sub></a><br /><a href=\"https://github.com/mansenfranzen/autodoc_pydantic/issues?q=author%3AITProKyle\" title=\"Bug reports\">\ud83d\udc1b</a></td>\n <td align=\"center\" valign=\"top\" width=\"14.28%\"><a href=\"https://github.com/bruno-f-cruz\"><img src=\"https://avatars.githubusercontent.com/u/7049351?v=4?s=100\" width=\"100px;\" alt=\"brunocruz\"/><br /><sub><b>brunocruz</b></sub></a><br /><a href=\"https://github.com/mansenfranzen/autodoc_pydantic/issues?q=author%3Abruno-f-cruz\" title=\"Bug reports\">\ud83d\udc1b</a></td>\n <td align=\"center\" valign=\"top\" width=\"14.28%\"><a href=\"https://github.com/AnneRademacher\"><img src=\"https://avatars.githubusercontent.com/u/49472656?v=4?s=100\" width=\"100px;\" alt=\"Anne Rademacher\"/><br /><sub><b>Anne Rademacher</b></sub></a><br /><a href=\"#financial-annerademacher\" title=\"Financial\">\ud83d\udcb5</a></td>\n <td align=\"center\" valign=\"top\" width=\"14.28%\"><a href=\"https://yaal.coop\"><img src=\"https://avatars.githubusercontent.com/u/60163?v=4?s=100\" width=\"100px;\" alt=\"\u00c9loi Rivard\"/><br /><sub><b>\u00c9loi Rivard</b></sub></a><br /><a href=\"https://github.com/mansenfranzen/autodoc_pydantic/issues?q=author%3Aazmeuk\" title=\"Bug reports\">\ud83d\udc1b</a></td>\n </tr>\n </tbody>\n</table>\n\n<!-- markdownlint-restore -->\n<!-- prettier-ignore-end -->\n\n<!-- ALL-CONTRIBUTORS-LIST:END -->\n\nThis project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Seamlessly integrate pydantic models in your Sphinx documentation.",
"version": "2.2.0",
"project_urls": {
"Documentation": "https://github.com/mansenfranzen/autodoc_pydantic",
"Homepage": "https://github.com/mansenfranzen/autodoc_pydantic",
"Repository": "https://github.com/mansenfranzen/autodoc_pydantic"
},
"split_keywords": [
"sphinx",
" pydantic",
" autodoc",
" documentation",
" extension"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "7bdf87120e2195f08d760bc5cf8a31cfa2381a6887517aa89453b23f1ae3354f",
"md5": "a5dd42db762f47fb6c988a454b47ea2d",
"sha256": "8c6a36fbf6ed2700ea9c6d21ea76ad541b621fbdf16b5a80ee04673548af4d95"
},
"downloads": -1,
"filename": "autodoc_pydantic-2.2.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "a5dd42db762f47fb6c988a454b47ea2d",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0.0,>=3.8.1",
"size": 34001,
"upload_time": "2024-04-27T10:57:00",
"upload_time_iso_8601": "2024-04-27T10:57:00.542657Z",
"url": "https://files.pythonhosted.org/packages/7b/df/87120e2195f08d760bc5cf8a31cfa2381a6887517aa89453b23f1ae3354f/autodoc_pydantic-2.2.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-27 10:57:00",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "mansenfranzen",
"github_project": "autodoc_pydantic",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"tox": true,
"lcname": "autodoc_pydantic"
}
JSON
