From e8cb416e26a5c6073428f999b91f3c73af6b7b0f Mon Sep 17 00:00:00 2001 From: Benjamin Bach Date: Thu, 6 Oct 2022 17:00:11 +0200 Subject: [PATCH 1/2] Adds changelog for 1.1.0alpha1 --- docs/changelog.rst | 48 +++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 47 insertions(+), 1 deletion(-) diff --git a/docs/changelog.rst b/docs/changelog.rst index 87422efda..0a5660252 100644 --- a/docs/changelog.rst +++ b/docs/changelog.rst @@ -5,7 +5,53 @@ Changelog Development version (|development_version|) =========================================== -.. |development_version| replace:: 1.0.1alpha1 +.. |development_version| replace:: 1.1.0alpha1 + +.. _release-1.1.0alpha1: + +1.1.0alpha1 +=========== + +Dependency Changes +------------------ + +Many documentation projects depend on ``sphinx-rtd-theme`` without specifying a version of the theme (unpinned) while also depending on unpinned versions of Sphinx. The latest version of ``sphinx-rtd-theme`` ideally always supports the latest version of Sphinx, but this is now guaranteed. + +This release adds upper bounds to direct dependencies ``Sphinx``, ``docutils`` and ``Jinja2``, which will safeguard from mixing with possibly incompatible future versions of Sphinx & friends. + +* Sphinx versions supported: 1.6 to 5.2.x +* ``Jinja<3.1`` (#1316) +* ``Sphinx<6`` (#1332) + + +Features +-------- + +* Nicer styles for (#967) + + +Fixes +----- + +* Suffixes in Sphinx version caused build errors (#1345) +* Table cells with multiple paragraphs gets wrong formatting (#289) +* Definition lists rendered wrongly in api docs (#1052) +* Citation not styled properly (#1078) + +Minor changes +------------- + +* Sphinx 5.2 added to test matrix (#1348) +* Python 3.10 added to test matrix (#1334) +* Supplemental Docker setup for development (#1319) +* Most of setup.py migrated to setup.cfg (#1116) + + +Incompatible Changes +-------------------- + +There are no known incompatible changes in this release, but we should note to users of ``docutils`` 0.18 and 0.19 that they are not yet support until ``sphinx-rtd-theme`` 1.2.0 is released. + .. _release-1.0.0: From 28492737e842acbe9d224e950ec147b8d422853d Mon Sep 17 00:00:00 2001 From: Benjamin Balder Bach Date: Fri, 7 Oct 2022 09:51:18 +0200 Subject: [PATCH 2/2] Update docs/changelog.rst Co-authored-by: Anthony --- docs/changelog.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/changelog.rst b/docs/changelog.rst index 0a5660252..3215b4c2e 100644 --- a/docs/changelog.rst +++ b/docs/changelog.rst @@ -50,7 +50,7 @@ Minor changes Incompatible Changes -------------------- -There are no known incompatible changes in this release, but we should note to users of ``docutils`` 0.18 and 0.19 that they are not yet support until ``sphinx-rtd-theme`` 1.2.0 is released. +There are no known incompatible changes in this release. Support for ``docutils`` versions 0.18 and 0.19 are scheduled for our next release. .. _release-1.0.0: