Skip to content

Commit

Permalink
Merge pull request #213 from mansenfranzen/finalize_2.1.0
Browse files Browse the repository at this point in the history
Finalize release v2.1.0
  • Loading branch information
mansenfranzen authored Mar 18, 2024
2 parents 77c1bf5 + 6bc9001 commit b9b4e2d
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 5 deletions.
5 changes: 3 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
![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)](https://pypi.org/project/autodoc-pydantic/)
![Python](https://img.shields.io/badge/python-3.7+-blue.svg?style=for-the-badge)
![Python](https://img.shields.io/badge/python-3.8+-blue.svg?style=for-the-badge)

[![Master](https://img.shields.io/github/actions/workflow/status/mansenfranzen/autodoc_pydantic/tests.yml?branch=main&style=for-the-badge)](https://github.com/mansenfranzen/autodoc_pydantic/actions/workflows/tests.yml)
[![Coverage](https://img.shields.io/codecov/c/gh/mansenfranzen/autodoc_pydantic?style=for-the-badge)](https://app.codecov.io/gh/mansenfranzen/autodoc_pydantic)
Expand Down Expand Up @@ -29,7 +29,8 @@ Don't worry - just `pip install autodoc_pydantic` ☺.
- 📋 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`
- 🔨 allows complete configurability on global and per-model level
- 🍀 supports `pydantic >= 1.5.0` and `sphinx >= 4.0.0`

## Documentation

Expand Down
2 changes: 1 addition & 1 deletion changelog.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
Changelog
=========

v2.1.0 - 2024-01-XX
v2.1.0 - 2024-03-18
-------------------

This is a maintenance and bugfix release extending support to pydantic v2.6,
Expand Down
5 changes: 3 additions & 2 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,8 @@ Features
- 📋 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`
- 🔨 allows complete configurability on global and per-model level
- 🍀 supports `pydantic >= 1.5.0` and `sphinx >= 4.0.0`

To see those features in action, jump over to the :ref:`example <showcase>` section comparing
the appearance of standard sphinx autodoc with **autodoc_pydantic**.
Expand Down Expand Up @@ -86,7 +87,7 @@ and all `contributors <https://github.com/mansenfranzen/autodoc_pydantic/tree/re
.. |DownloadsBadge| image:: https://img.shields.io/pypi/dm/autodoc_pydantic?color=fe7d37&style=flat
.. _DownloadsBadge: https://pypistats.org/packages/autodoc-pydantic

.. |ContributersBadge| image:: https://img.shields.io/badge/all_contributors-41-orange.svg?style=flat
.. |ContributersBadge| image:: https://img.shields.io/badge/all_contributors-47-orange.svg?style=flat
.. _ContributersBadge: https://github.com/mansenfranzen/autodoc_pydantic/tree/refactor_inspection#acknowledgements

.. |CoverageBadge| image:: https://img.shields.io/codecov/c/gh/mansenfranzen/autodoc_pydantic?style=flat
Expand Down

0 comments on commit b9b4e2d

Please sign in to comment.