From 6bc90013d18f81524201fb8b938836c2f6fe12c3 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Franz=20W=C3=B6llert?= Date: Mon, 18 Mar 2024 09:08:37 +0100 Subject: [PATCH] Update readme and changelog. --- README.md | 5 +++-- changelog.rst | 2 +- docs/source/index.rst | 5 +++-- 3 files changed, 7 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 744fd2fd..230cc896 100644 --- a/README.md +++ b/README.md @@ -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) @@ -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 diff --git a/changelog.rst b/changelog.rst index eee24e8b..7a29b661 100644 --- a/changelog.rst +++ b/changelog.rst @@ -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, diff --git a/docs/source/index.rst b/docs/source/index.rst index 83d59aee..a6f43735 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -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 ` section comparing the appearance of standard sphinx autodoc with **autodoc_pydantic**. @@ -86,7 +87,7 @@ and all `contributors