From 91770b4b77b2673c52965d3de4642f32819ef6eb Mon Sep 17 00:00:00 2001 From: Benjamin Bach Date: Thu, 15 Dec 2022 13:39:15 +0100 Subject: [PATCH 1/2] Add changelog entry for docutils 0.18 support --- docs/changelog.rst | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/docs/changelog.rst b/docs/changelog.rst index fd6302b51..9f8a7bf17 100644 --- a/docs/changelog.rst +++ b/docs/changelog.rst @@ -9,6 +9,21 @@ Development version (|development_version|) .. |development_version| replace:: 1.1.2alpha1 +Dependency Changes +------------------ + +* docutils 0.18 is supported. (#1381) + +Note for users of Sphinx<3 +-------------------------- + +If you have pinned your documentation project to use versions of +``sphinx<1.8.6`` or ``Sphinx>=2.0,<2.4.5``, you need to either +add ``docutils<0.18`` to your requirements since newer versions of docutils are incompatible with these older Sphinx versions +**or** +update to a later release of Sphinx that has docutils correctly pinned. +Read more in `this comment `. + .. _release-1.1.1: 1.1.1 From a85c8a1e9d880b05e41f65b24c1551dc8fb7015d Mon Sep 17 00:00:00 2001 From: Benjamin Balder Bach Date: Thu, 15 Dec 2022 19:36:59 +0100 Subject: [PATCH 2/2] Update docs/changelog.rst Co-authored-by: Anthony --- docs/changelog.rst | 10 ++++------ 1 file changed, 4 insertions(+), 6 deletions(-) diff --git a/docs/changelog.rst b/docs/changelog.rst index 9f8a7bf17..a75452290 100644 --- a/docs/changelog.rst +++ b/docs/changelog.rst @@ -17,12 +17,10 @@ Dependency Changes Note for users of Sphinx<3 -------------------------- -If you have pinned your documentation project to use versions of -``sphinx<1.8.6`` or ``Sphinx>=2.0,<2.4.5``, you need to either -add ``docutils<0.18`` to your requirements since newer versions of docutils are incompatible with these older Sphinx versions -**or** -update to a later release of Sphinx that has docutils correctly pinned. -Read more in `this comment `. +If you cannot use a more recent Sphinx release, +you should at least ensure you are using the most recent release for your major version. +Currently, these are Sphinx `1.8.6` and `2.4.5`. +Older releases may install unsupported versions of several dependencies, including Jinja2 and docutils. .. _release-1.1.1: