From bf2ff281d20a51d0039f810ecf708d34ffe71155 Mon Sep 17 00:00:00 2001 From: Ashley Whetter Date: Mon, 20 May 2024 09:36:28 -0700 Subject: [PATCH] Version 3.1.0 --- CHANGELOG.rst | 28 ++++++++++++++++++++++++++++ autoapi/__init__.py | 4 ++-- docs/changes/+59dd3b40.misc | 1 - docs/changes/+8cd14c4f.bugfix | 1 - docs/changes/+af2042c3.misc | 1 - docs/changes/+cf0a1267.misc | 1 - docs/changes/224.bugfix | 1 - docs/changes/226.feature | 1 - docs/changes/388.misc | 1 - docs/changes/398.bugfix | 1 - docs/changes/412.bugfix | 1 - docs/changes/414.feature | 1 - docs/changes/423.bugfix | 1 - docs/changes/427.bugfix | 1 - docs/changes/445.bugfix | 1 - 15 files changed, 30 insertions(+), 15 deletions(-) delete mode 100644 docs/changes/+59dd3b40.misc delete mode 100644 docs/changes/+8cd14c4f.bugfix delete mode 100644 docs/changes/+af2042c3.misc delete mode 100644 docs/changes/+cf0a1267.misc delete mode 100644 docs/changes/224.bugfix delete mode 100644 docs/changes/226.feature delete mode 100644 docs/changes/388.misc delete mode 100644 docs/changes/398.bugfix delete mode 100644 docs/changes/412.bugfix delete mode 100644 docs/changes/414.feature delete mode 100644 docs/changes/423.bugfix delete mode 100644 docs/changes/427.bugfix delete mode 100644 docs/changes/445.bugfix diff --git a/CHANGELOG.rst b/CHANGELOG.rst index f5c203e0..a0ec4cb1 100644 --- a/CHANGELOG.rst +++ b/CHANGELOG.rst @@ -5,6 +5,34 @@ Versions follow `Semantic Versioning `_ (``.. .. towncrier release notes start +v3.1.0 (2024-05-20) +------------------- + +Features +^^^^^^^^ + +- Objects can render to their own page (#226) +- Render PEP-695 type aliases as TypeAlias assignments. (#414) + + +Bugfixes +^^^^^^^^ + +- Values are always rendered for TypeAlises and PEP-695 type aliases. (#224) +- Fix submodule with `__init__.pyi` documented as `__init__` instead of submodule name (#398) +- Fix IndexError when a module docstring contains only a heading (#412) +- Preserve strings inside Literal type annotations (#423) +- Stopped using xrefs in page titles (#427) +- Fix unpickable configuration value warning when using autoapi_prepare_jinja_env (#445) +- Fix emitting ignore event twice for methods. + + +Misc +^^^^ + +- #388 + + v3.0.0 (2023-09-26) ------------------- diff --git a/autoapi/__init__.py b/autoapi/__init__.py index 796003e3..7cbd64eb 100644 --- a/autoapi/__init__.py +++ b/autoapi/__init__.py @@ -3,5 +3,5 @@ from .extension import setup __all__ = ("setup",) -__version__ = "3.0.0" -__version_info__ = (3, 0, 0) +__version__ = "3.1.0" +__version_info__ = (3, 1, 0) diff --git a/docs/changes/+59dd3b40.misc b/docs/changes/+59dd3b40.misc deleted file mode 100644 index 02f99c44..00000000 --- a/docs/changes/+59dd3b40.misc +++ /dev/null @@ -1 +0,0 @@ -Made links to the documention in the README less confusing. \ No newline at end of file diff --git a/docs/changes/+8cd14c4f.bugfix b/docs/changes/+8cd14c4f.bugfix deleted file mode 100644 index 10756f99..00000000 --- a/docs/changes/+8cd14c4f.bugfix +++ /dev/null @@ -1 +0,0 @@ -Fix emitting ignore event twice for methods. \ No newline at end of file diff --git a/docs/changes/+af2042c3.misc b/docs/changes/+af2042c3.misc deleted file mode 100644 index aad730b8..00000000 --- a/docs/changes/+af2042c3.misc +++ /dev/null @@ -1 +0,0 @@ -Reformatted to latest stable black style. \ No newline at end of file diff --git a/docs/changes/+cf0a1267.misc b/docs/changes/+cf0a1267.misc deleted file mode 100644 index a390c4c9..00000000 --- a/docs/changes/+cf0a1267.misc +++ /dev/null @@ -1 +0,0 @@ -Refactor mapper classes into their bases \ No newline at end of file diff --git a/docs/changes/224.bugfix b/docs/changes/224.bugfix deleted file mode 100644 index 242210f6..00000000 --- a/docs/changes/224.bugfix +++ /dev/null @@ -1 +0,0 @@ -Values are always rendered for TypeAlises and PEP-695 type aliases. diff --git a/docs/changes/226.feature b/docs/changes/226.feature deleted file mode 100644 index ad593931..00000000 --- a/docs/changes/226.feature +++ /dev/null @@ -1 +0,0 @@ -Objects can render to their own page \ No newline at end of file diff --git a/docs/changes/388.misc b/docs/changes/388.misc deleted file mode 100644 index 8774744e..00000000 --- a/docs/changes/388.misc +++ /dev/null @@ -1 +0,0 @@ -Implemented automatic uploading to PyPI \ No newline at end of file diff --git a/docs/changes/398.bugfix b/docs/changes/398.bugfix deleted file mode 100644 index 22ee1449..00000000 --- a/docs/changes/398.bugfix +++ /dev/null @@ -1 +0,0 @@ -Fix submodule with `__init__.pyi` documented as `__init__` instead of submodule name \ No newline at end of file diff --git a/docs/changes/412.bugfix b/docs/changes/412.bugfix deleted file mode 100644 index 462d8c53..00000000 --- a/docs/changes/412.bugfix +++ /dev/null @@ -1 +0,0 @@ -Fix IndexError when a module docstring contains only a heading \ No newline at end of file diff --git a/docs/changes/414.feature b/docs/changes/414.feature deleted file mode 100644 index 6e0b06fe..00000000 --- a/docs/changes/414.feature +++ /dev/null @@ -1 +0,0 @@ -Render PEP-695 type aliases as TypeAlias assignments. diff --git a/docs/changes/423.bugfix b/docs/changes/423.bugfix deleted file mode 100644 index 0f45e837..00000000 --- a/docs/changes/423.bugfix +++ /dev/null @@ -1 +0,0 @@ -Preserve strings inside Literal type annotations \ No newline at end of file diff --git a/docs/changes/427.bugfix b/docs/changes/427.bugfix deleted file mode 100644 index 590a706a..00000000 --- a/docs/changes/427.bugfix +++ /dev/null @@ -1 +0,0 @@ -Stopped using xrefs in page titles \ No newline at end of file diff --git a/docs/changes/445.bugfix b/docs/changes/445.bugfix deleted file mode 100644 index 31230ea5..00000000 --- a/docs/changes/445.bugfix +++ /dev/null @@ -1 +0,0 @@ -Fix unpickable configuration value warning when using autoapi_prepare_jinja_env \ No newline at end of file