https://github.com/mansenfranzen/autodoc_pydantic

Seamlessly integrate pydantic models in your Sphinx documentation.
https://github.com/mansenfranzen/autodoc_pydantic

autodoc documentation pydantic python sphinx sphinx-extension

Last synced: 29 days ago
JSON representation

Seamlessly integrate pydantic models in your Sphinx documentation.

Host: GitHub
URL: https://github.com/mansenfranzen/autodoc_pydantic
Owner: mansenfranzen
License: mit
Created: 2021-03-24T09:26:41.000Z (about 4 years ago)
Default Branch: main
Last Pushed: 2025-04-01T12:58:43.000Z (about 1 month ago)
Last Synced: 2025-04-07T05:00:45.418Z (about 1 month ago)
Topics: autodoc, documentation, pydantic, python, sphinx, sphinx-extension
Language: Python
Homepage:
Size: 2.7 MB
Stars: 165
Watchers: 5
Forks: 27
Open Issues: 39
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Codeowners: CODEOWNERS

Awesome Lists containing this project

awesome-pydantic - autodoc_pydantic - Seamlessly integrate pydantic models in your Sphinx documentation. (Utilities)
awesome-pydantic - autodoc_pydantic - Seamlessly integrate pydantic models in your Sphinx documentation. (Utilities)

README

        ![Autodoc Pydantic](https://raw.githubusercontent.com/mansenfranzen/autodoc_pydantic/main/docs/source/material/logo_black.svg)

[![PyPI - Version](https://img.shields.io/pypi/v/autodoc_pydantic?style=for-the-badge&logo=python&logoColor=white)](https://pypi.org/project/autodoc_pydantic/)

[![Python](https://img.shields.io/badge/python-3.8+-blue.svg?style=for-the-badge&logo=python&logoColor=white)](https://www.python.org/)

[![PyPI - Downloads](https://img.shields.io/pypi/dm/autodoc_pydantic?style=for-the-badge&logo=python&logoColor=white&color=blue)](https://pypistats.org/packages/autodoc-pydantic)

[![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/mansenfranzen/autodoc_pydantic/tests-push-pr.yml?style=for-the-badge&logo=github)](https://github.com/mansenfranzen/autodoc_pydantic/actions)

[![Codecov](https://img.shields.io/codecov/c/gh/mansenfranzen/autodoc_pydantic?style=for-the-badge&logo=codecov)](https://app.codecov.io/gh/mansenfranzen/autodoc_pydantic)

[![Read the Docs (stable)](https://img.shields.io/readthedocs/autodoc_pydantic/stable?style=for-the-badge&logo=sphinx&label=Docs%20stable)](https://autodoc-pydantic.readthedocs.io/en/stable/)

[![GitHub License](https://img.shields.io/github/license/mansenfranzen/autodoc_pydantic?style=for-the-badge&color=orange&logo=semanticscholar&logoColor=white)](https://github.com/mansenfranzen/autodoc_pydantic/blob/main/LICENSE)

[![linting - ruff](https://img.shields.io/badge/Linting-orange?style=for-the-badge&logo=ruff&logoColor=white&label=ruff)](https://github.com/astral-sh/ruff)

[![types - Mypy](https://img.shields.io/badge/types-Mypy-orange.svg?style=for-the-badge&logo=python&logoColor=white)](https://github.com/python/mypy)

[![All Contributors](https://img.shields.io/badge/all_contributors-57-orange.svg?style=for-the-badge)](https://github.com/mansenfranzen/autodoc_pydantic?tab=readme-ov-file#-acknowledgements)

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:

  

    

      
_{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}
🐛 💬

      
_{Mitchell Blyth}
💬

    

    

      
_{John-Luke Navarro}
💬

    

  

This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!

ecosyste.ms

Data

Tools

Indexes

Applications

Experiments

Awesome

https://github.com/mansenfranzen/autodoc_pydantic

Awesome Lists containing this project

README