From fa3b54267591747ed4b16bd980c38d0ffa744111 Mon Sep 17 00:00:00 2001 From: AlexWaygood Date: Tue, 25 Apr 2023 17:53:42 -0600 Subject: [PATCH 1/3] Docs build: Add upper bounds to transitive dependencies --- Doc/constraints.txt | 17 +++++++++++++++++ Doc/requirements.txt | 4 ++++ 2 files changed, 21 insertions(+) create mode 100644 Doc/constraints.txt diff --git a/Doc/constraints.txt b/Doc/constraints.txt new file mode 100644 index 00000000000000..74d81c48be6422 --- /dev/null +++ b/Doc/constraints.txt @@ -0,0 +1,17 @@ +babel<3 +colorama<0.5 +imagesize<1.5 +Jinja2<3.2 +MarkupSafe<2.2 +packaging<24 +polib<1.3 +Pygments<2.16,!=2.15.0 # Pygments==2.15.0 breaks CI +regex<2024 +requests<3 +snowballstemmer<3 +sphinxcontrib-applehelp<1.1 +sphinxcontrib-devhelp<1.1 +sphinxcontrib-htmlhelp<2.1 +sphinxcontrib-jsmath<1.1 +sphinxcontrib-qthelp<1.1 +sphinxcontrib-serializinghtml<1.2 diff --git a/Doc/requirements.txt b/Doc/requirements.txt index 71d3cd61e53877..b507043edaec19 100644 --- a/Doc/requirements.txt +++ b/Doc/requirements.txt @@ -13,3 +13,7 @@ sphinxext-opengraph==0.7.5 # The theme used by the documentation is stored separately, so we need # to install that as well. python-docs-theme>=2022.1 + +# We have upper bounds on our transitive dependencies in constraints.txt +# To avoid new releases unexpectedly breaking our build +-c constraints.txt From 250c82de2cdaaeabf8d0758707edde00b189d96d Mon Sep 17 00:00:00 2001 From: AlexWaygood Date: Tue, 25 Apr 2023 18:20:20 -0600 Subject: [PATCH 2/3] Improve comments as per review --- Doc/constraints.txt | 14 ++++++++++---- 1 file changed, 10 insertions(+), 4 deletions(-) diff --git a/Doc/constraints.txt b/Doc/constraints.txt index 74d81c48be6422..7b087ded6cacd9 100644 --- a/Doc/constraints.txt +++ b/Doc/constraints.txt @@ -1,12 +1,11 @@ +# Direct dependencies of Sphinx babel<3 colorama<0.5 imagesize<1.5 Jinja2<3.2 -MarkupSafe<2.2 packaging<24 -polib<1.3 -Pygments<2.16,!=2.15.0 # Pygments==2.15.0 breaks CI -regex<2024 +# Pygments==2.15.0 breaks CI +Pygments<2.16,!=2.15.0 requests<3 snowballstemmer<3 sphinxcontrib-applehelp<1.1 @@ -15,3 +14,10 @@ sphinxcontrib-htmlhelp<2.1 sphinxcontrib-jsmath<1.1 sphinxcontrib-qthelp<1.1 sphinxcontrib-serializinghtml<1.2 + +# Direct dependencies of Jinja2 (Jinja is a dependency of Sphinx, see above) +MarkupSafe<2.2 + +# Direct dependencies of sphinx-lint +polib<1.3 +regex<2024 From a2dd54f2ecba3af2a122f221d7cceb5d9206047a Mon Sep 17 00:00:00 2001 From: AlexWaygood Date: Wed, 26 Apr 2023 10:08:39 -0600 Subject: [PATCH 3/3] Improve comments --- Doc/constraints.txt | 6 ++++++ Doc/requirements.txt | 5 +++-- 2 files changed, 9 insertions(+), 2 deletions(-) diff --git a/Doc/constraints.txt b/Doc/constraints.txt index 7b087ded6cacd9..66c748eb092d83 100644 --- a/Doc/constraints.txt +++ b/Doc/constraints.txt @@ -1,3 +1,9 @@ +# We have upper bounds on our transitive dependencies here +# To avoid new releases unexpectedly breaking our build. +# This file can be updated on an ad-hoc basis, +# though it will probably have to be updated +# whenever Doc/requirements.txt is updated. + # Direct dependencies of Sphinx babel<3 colorama<0.5 diff --git a/Doc/requirements.txt b/Doc/requirements.txt index b507043edaec19..9cbd15c2209dc6 100644 --- a/Doc/requirements.txt +++ b/Doc/requirements.txt @@ -1,4 +1,7 @@ # Requirements to build the Python documentation +# +# Note that when updating this file, you will likely also have to update +# the Doc/constraints.txt file. # Sphinx version is pinned so that new versions that introduce new warnings # won't suddenly cause build failures. Updating the version is fine as long @@ -14,6 +17,4 @@ sphinxext-opengraph==0.7.5 # to install that as well. python-docs-theme>=2022.1 -# We have upper bounds on our transitive dependencies in constraints.txt -# To avoid new releases unexpectedly breaking our build -c constraints.txt