From cf69cad56f6066418a1fcf6b10a769168a98e280 Mon Sep 17 00:00:00 2001 From: Adrian Sampson Date: Thu, 20 Jan 2022 14:24:08 -0500 Subject: [PATCH 1/2] Pin Sphinx <4.4.0 in CI A recent change in Sphinx introduced a new warning about missed extlink opportunities: https://github.com/sphinx-doc/sphinx/issues/10112 These warnings are causing spurious CI failures. Some of these suggestions are good but many of them are not, and there is not currently a way to disable the warning (globally or locally). So the only workable solution currently seems to be to pin an old version of Sphinx in CI for now. Hopefully there will be an option to disable this in 4.4.1, at which point we can unpin. --- .github/workflows/ci.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/ci.yaml b/.github/workflows/ci.yaml index 137f74b72c..d4ec20061b 100644 --- a/.github/workflows/ci.yaml +++ b/.github/workflows/ci.yaml @@ -86,7 +86,7 @@ jobs: - name: Install base dependencies run: | python -m pip install --upgrade pip - python -m pip install tox sphinx + python -m pip install tox 'sphinx<4.4.0' - name: Add problem matcher run: echo "::add-matcher::.github/sphinx-problem-matcher.json" From 1bcec4e5f0cd18c82733ceec2c16b6458308d47c Mon Sep 17 00:00:00 2001 From: Adrian Sampson Date: Thu, 20 Jan 2022 14:39:04 -0500 Subject: [PATCH 2/2] Move Sphinx pin to tox.ini Turns out the Sphinx installed "outside" of the tox virtualenv is not the one that actually builds the docs... --- .github/workflows/ci.yaml | 2 +- tox.ini | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/ci.yaml b/.github/workflows/ci.yaml index d4ec20061b..137f74b72c 100644 --- a/.github/workflows/ci.yaml +++ b/.github/workflows/ci.yaml @@ -86,7 +86,7 @@ jobs: - name: Install base dependencies run: | python -m pip install --upgrade pip - python -m pip install tox 'sphinx<4.4.0' + python -m pip install tox sphinx - name: Add problem matcher run: echo "::add-matcher::.github/sphinx-problem-matcher.json" diff --git a/tox.ini b/tox.ini index 5a5b78b31e..5f9de07f6c 100644 --- a/tox.ini +++ b/tox.ini @@ -24,7 +24,7 @@ commands = [testenv:docs] basepython = python3.9 -deps = sphinx +deps = sphinx<4.4.0 commands = sphinx-build -W -q -b html docs {envtmpdir}/html {posargs} # checks all links in the docs