autodoc_pydantic

Seamlessly integrate pydantic models in your Sphinx documentation.

public

Forked

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
🍀 Supports pydantic >= 1.5.0 and sphinx >= 4.0.0

For more details, please visit the official documentation:

To see those features in action, jump over to the example documentation to compare
the appearance of standard sphinx autodoc with autodoc_pydantic.

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

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

Find me