From c47c0f522fef59b3b9c7ec8473efa228e7e3a30d Mon Sep 17 00:00:00 2001
From: Manuel Kaufmann <humitos@gmail.com>
Date: Mon, 8 Nov 2021 10:16:14 +0100
Subject: [PATCH] Update test suite: run Python 3.10

- pin docutils<0.18 on some Sphinx versions
- use Python 3.10 to run the test suite
- refactor CircleCI to use parameters
- remove old environment variables on docs env
---
 .circleci/config.yml | 61 +++++++++++++++++++++++++-------------------
 tox.ini              | 18 +++++++++----
 2 files changed, 48 insertions(+), 31 deletions(-)

diff --git a/.circleci/config.yml b/.circleci/config.yml
index 41be37cd..4bdb3a72 100644
--- a/.circleci/config.yml
+++ b/.circleci/config.yml
@@ -1,54 +1,63 @@
 version: 2.1
 
 commands:
-  run-tests:
+  run-tox:
+    description: "Run tox"
+    parameters:
+      version:
+        type: string
+      sphinx-version:
+        type: string
+        default: "18,20,21,22,23,24,30,31,32,33,34,35,40,41,42,latest"
     steps:
       - checkout
       - run: pip install --user tox
-      - run: tox
+      - run: tox -e "<<parameters.version>>-sphinx{<<parameters.sphinx-version>>}"
 
 jobs:
-  tests-py36:
+  py36:
     docker:
       - image: 'cimg/python:3.6'
-    environment:
-        # Select only the environments that match the Python version we have
-        # installed in this Docker image (e.g. `py36-*`). Use TOX_SKIP_ENV with
-        # a negated regex to only match the environment we want to run. Read
-        # more at https://github.com/tox-dev/tox/issues/238
-        TOX_SKIP_ENV: '^(?!py36-)'
     steps:
-      - run-tests
-  tests-py37:
+      - run-tox:
+          version: py36
+  py37:
     docker:
       - image: 'cimg/python:3.7'
-    environment:
-      TOX_SKIP_ENV: '^(?!py37-)'
     steps:
-      - run-tests
+      - run-tox:
+          version: py37
 
-  tests-py38:
+  py38:
     docker:
       - image: 'cimg/python:3.8'
-    environment:
-      TOX_SKIP_ENV: '^(?!py38-)'
     steps:
-      - run-tests
+      - run-tox:
+          version: py38
 
-  tests-py39:
+  py39:
     docker:
       - image: 'cimg/python:3.9'
-    environment:
-      TOX_SKIP_ENV: '^(?!py39-)'
     steps:
-      - run-tests
+      - run-tox:
+          version: py39
 
+  py310:
+    docker:
+      - image: 'cimg/python:3.10'
+    steps:
+      - run-tox:
+          version: py310
+          # Do not run tests for Python 3.10 and some versions of Sphinx because it's broken
+          # See https://github.com/sphinx-doc/sphinx/issues/9816
+          sphinx-version: "18,20,21,22,23,24,42,latest"
 
 workflows:
   version: 2
   test:
     jobs:
-      - tests-py36
-      - tests-py37
-      - tests-py38
-      - tests-py39
+      - py36
+      - py37
+      - py38
+      - py39
+      - py310
diff --git a/tox.ini b/tox.ini
index 998c31d3..b74763f5 100644
--- a/tox.ini
+++ b/tox.ini
@@ -1,7 +1,8 @@
 [tox]
 envlist =
   docs
-  py{36,37,38,39}-sphinx{18,20,21,22,23,24,30,31,32,33,34,35,latest}
+  py{36,37,38,39}-sphinx{18,20,21,22,23,24,30,31,32,33,34,35,40,41,42,latest}
+  py{310}-sphinx{18,20,21,22,23,24,42,latest}
 
 [testenv]
 deps =
@@ -22,10 +23,20 @@ deps =
   sphinx34: sphinx~=3.4.0
   sphinx35: sphinx~=3.5.0
   sphinx40: sphinx~=4.0.0
+  sphinx41: sphinx~=4.1.0
+  sphinx42: sphinx~=4.2.0
   sphinxlatest: sphinx
 commands = pytest {posargs}
 
-[testenv:py38-sphinx30]
+# Pin docutils<0.18 for all Python versions using Sphinx 1.x, 2.x, 3.x, 4.0, 4.1
+# since it's incompatible and generating lot of errors
+# https://tox.wiki/en/latest/config.html#generating-environments-conditional-settings
+[testenv:py{36,37,38,39,310}-sphinx{18,20,21,22,23,24,30,31,32,33,34,35,40,41}]
+deps =
+  {[testenv]deps}
+  docutils<0.18
+
+[testenv:py310-sphinx42]
 deps =
   {[testenv]deps}
   pytest-cov
@@ -36,8 +47,5 @@ deps =
   -r {toxinidir}/docs/requirements.txt
   .
 changedir = {toxinidir}/docs
-setenv =
-  READTHEDOCS_PROJECT = sphinx-hoverxref
-  READTHEDOCS_VERSION = latest
 commands =
     sphinx-build -W -E -q -b html -d {envtmpdir}/doctrees . {envtmpdir}/html