From 8729fc822159297abf5bb0064bc9b0a9e9c4432a Mon Sep 17 00:00:00 2001 From: Simon Conseil Date: Fri, 6 Jan 2023 18:06:15 +0100 Subject: [PATCH 01/10] Updates for tox and sphinx --- .github/workflows/ci_workflows.yml | 8 +++++++- setup.cfg | 2 ++ tox.ini | 7 +++++-- 3 files changed, 14 insertions(+), 3 deletions(-) diff --git a/.github/workflows/ci_workflows.yml b/.github/workflows/ci_workflows.yml index 9df00bb..1aef5a6 100644 --- a/.github/workflows/ci_workflows.yml +++ b/.github/workflows/ci_workflows.yml @@ -44,6 +44,12 @@ jobs: - os: ubuntu-latest python-version: '3.10' toxenv: py310-test-sphinxdev + - os: ubuntu-latest + python-version: '3.11' + toxenv: py310-test-sphinx53 + - os: ubuntu-latest + python-version: '3.11' + toxenv: py310-test-sphinx61 # MacOS X - just the oldest, stable, and dev - os: macos-latest @@ -89,7 +95,7 @@ jobs: if: startsWith(matrix.os, 'windows') run: choco install graphviz - name: Install tox - run: python -m pip install "tox<4" + run: python -m pip install tox - name: Install codecov if: ${{ contains(matrix.toxenv,'-cov') }} run: python -m pip install codecov diff --git a/setup.cfg b/setup.cfg index 4886f2c..c48c2a6 100644 --- a/setup.cfg +++ b/setup.cfg @@ -44,6 +44,8 @@ filterwarnings = ignore:'contextfunction' is renamed to 'pass_context':DeprecationWarning ignore:'environmentfilter' is renamed to 'pass_environment':DeprecationWarning ignore:distutils Version classes are deprecated:DeprecationWarning + ignore:'imghdr' is deprecated and slated for removal in Python 3.13:DeprecationWarning + ignore:The alias 'sphinx\.util\.SkipProgressMessage' is deprecated.*:sphinx.deprecation.RemovedInSphinx80Warning [flake8] max-line-length = 125 diff --git a/tox.ini b/tox.ini index b85e8ee..7e4c94a 100644 --- a/tox.ini +++ b/tox.ini @@ -1,5 +1,5 @@ [tox] -envlist = py{37,38,39,310}-test-sphinx{24,35,40,41,42,43,dev}{,-cov}{-clocale,} +envlist = py{37,38,39,310,311}-test-sphinx{24,35,40,41,42,43,53,60,61,dev}{,-cov}{-clocale,} requires = pip >= 18.0 setuptools >= 30.3.0 isolated_build = true @@ -15,6 +15,9 @@ deps = sphinx41: sphinx==4.1.* sphinx42: sphinx==4.2.* sphinx43: sphinx==4.3.* + sphinx53: sphinx==5.3.* + sphinx60: sphinx==6.0.* + sphinx61: sphinx==6.1.* sphinxdev: git+https://github.com/sphinx-doc/sphinx.git extras = test: test @@ -23,7 +26,7 @@ commands = !cov: pytest --pyargs sphinx_automodapi cov: pytest --pyargs sphinx_automodapi --cov sphinx_automodapi --cov-config={toxinidir}/setup.cfg {posargs} cov: coverage xml -o {toxinidir}/coverage.xml -passenv = HOME WINDIR LC_ALL LC_CTYPE LANG CC CI +passenv = HOME, WINDIR, LC_ALL, LC_CTYPE, LANG, CC, CI setenv = cov: CFLAGS = --coverage -fno-inline-functions -O0 clocale: LC_CTYPE=C From 157a4d34c522e893c7178ecdc12a6ffa162ee014 Mon Sep 17 00:00:00 2001 From: Simon Conseil Date: Fri, 6 Jan 2023 18:11:33 +0100 Subject: [PATCH 02/10] what a mess --- setup.cfg | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/setup.cfg b/setup.cfg index c48c2a6..88411ea 100644 --- a/setup.cfg +++ b/setup.cfg @@ -45,7 +45,7 @@ filterwarnings = ignore:'environmentfilter' is renamed to 'pass_environment':DeprecationWarning ignore:distutils Version classes are deprecated:DeprecationWarning ignore:'imghdr' is deprecated and slated for removal in Python 3.13:DeprecationWarning - ignore:The alias 'sphinx\.util\.SkipProgressMessage' is deprecated.*:sphinx.deprecation.RemovedInSphinx80Warning + ignore:The alias 'sphinx\.util\.SkipProgressMessage' is deprecated.* [flake8] max-line-length = 125 From f793b311ea082785761850db4517c5299b05b94a Mon Sep 17 00:00:00 2001 From: Simon Conseil Date: Fri, 6 Jan 2023 19:28:24 +0100 Subject: [PATCH 03/10] Remove -W for tests --- sphinx_automodapi/tests/helpers.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/sphinx_automodapi/tests/helpers.py b/sphinx_automodapi/tests/helpers.py index 5fb34a0..aa3e470 100644 --- a/sphinx_automodapi/tests/helpers.py +++ b/sphinx_automodapi/tests/helpers.py @@ -42,7 +42,7 @@ def run_sphinx_in_tmpdir(tmpdir, additional_conf={}, expect_error=False): write_conf(tmpdir.join('conf.py').strpath, conf) - argv = ['-W', '-b', 'html', '.', '_build/html'] + argv = ['-b', 'html', '.', '_build/html'] try: os.chdir(tmpdir.strpath) From 3b1d41c24fa2e1078a6341febe394f1806bd276d Mon Sep 17 00:00:00 2001 From: "P. L. Lim" <2090236+pllim@users.noreply.github.com> Date: Fri, 20 Jan 2023 07:12:07 -0500 Subject: [PATCH 04/10] Ignore progress_message deprecation from Sphinx --- setup.cfg | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/setup.cfg b/setup.cfg index 88411ea..e711d88 100644 --- a/setup.cfg +++ b/setup.cfg @@ -45,7 +45,8 @@ filterwarnings = ignore:'environmentfilter' is renamed to 'pass_environment':DeprecationWarning ignore:distutils Version classes are deprecated:DeprecationWarning ignore:'imghdr' is deprecated and slated for removal in Python 3.13:DeprecationWarning - ignore:The alias 'sphinx\.util\.SkipProgressMessage' is deprecated.* + ignore:The alias 'sphinx\.util\.SkipProgressMessage' is deprecated + ignore:The alias 'sphinx\.util\.progress_message' is deprecated [flake8] max-line-length = 125 From bae1022a075502a0d6d55caf5fda0e838b65ea0e Mon Sep 17 00:00:00 2001 From: "P. L. Lim" <2090236+pllim@users.noreply.github.com> Date: Fri, 20 Jan 2023 08:00:21 -0500 Subject: [PATCH 05/10] Put -W back and see what happens --- sphinx_automodapi/tests/helpers.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/sphinx_automodapi/tests/helpers.py b/sphinx_automodapi/tests/helpers.py index aa3e470..5fb34a0 100644 --- a/sphinx_automodapi/tests/helpers.py +++ b/sphinx_automodapi/tests/helpers.py @@ -42,7 +42,7 @@ def run_sphinx_in_tmpdir(tmpdir, additional_conf={}, expect_error=False): write_conf(tmpdir.join('conf.py').strpath, conf) - argv = ['-b', 'html', '.', '_build/html'] + argv = ['-W', '-b', 'html', '.', '_build/html'] try: os.chdir(tmpdir.strpath) From 912121805e0a27db2ad743abf330719a8cad2d08 Mon Sep 17 00:00:00 2001 From: "P. L. Lim" <2090236+pllim@users.noreply.github.com> Date: Fri, 20 Jan 2023 08:35:50 -0500 Subject: [PATCH 06/10] Bump workflow versions --- .github/workflows/ci_workflows.yml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/.github/workflows/ci_workflows.yml b/.github/workflows/ci_workflows.yml index 1aef5a6..1dd40d1 100644 --- a/.github/workflows/ci_workflows.yml +++ b/.github/workflows/ci_workflows.yml @@ -74,11 +74,11 @@ jobs: toxenv: py39-test-sphinxdev steps: - - uses: actions/checkout@v2 + - uses: actions/checkout@v3 with: fetch-depth: 0 - name: Set up Python ${{ matrix.python-version }} - uses: actions/setup-python@v2 + uses: actions/setup-python@v4 with: python-version: ${{ matrix.python-version }} - name: Install graphviz on Linux @@ -103,6 +103,6 @@ jobs: run: tox ${{ matrix.toxargs }} -v -e ${{ matrix.toxenv }} - name: Upload coverage to codecov if: ${{ contains(matrix.toxenv,'-cov') }} - uses: codecov/codecov-action@v2 + uses: codecov/codecov-action@v3 with: file: ./coverage.xml From d28b661b50a4a9e9679d73a1c55bfa1f6d08b9a7 Mon Sep 17 00:00:00 2001 From: "P. L. Lim" <2090236+pllim@users.noreply.github.com> Date: Fri, 20 Jan 2023 08:47:38 -0500 Subject: [PATCH 07/10] No clocale for Windows --- .github/workflows/ci_workflows.yml | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/.github/workflows/ci_workflows.yml b/.github/workflows/ci_workflows.yml index 1dd40d1..7d0e1ab 100644 --- a/.github/workflows/ci_workflows.yml +++ b/.github/workflows/ci_workflows.yml @@ -63,13 +63,13 @@ jobs: toxenv: py39-test-sphinxdev # Windows - just the oldest, stable, and dev - - os: windows-2019 + - os: windows-latest python-version: 3.7 toxenv: py37-test-sphinx24 - - os: windows-2019 + - os: windows-latest python-version: 3.8 - toxenv: py38-test-sphinx43-clocale - - os: windows-2019 + toxenv: py38-test-sphinx43 + - os: windows-latest python-version: 3.9 toxenv: py39-test-sphinxdev From 62541ff6a97e7cc67ed7576686368a0f819bd506 Mon Sep 17 00:00:00 2001 From: "P. L. Lim" <2090236+pllim@users.noreply.github.com> Date: Fri, 20 Jan 2023 09:22:39 -0500 Subject: [PATCH 08/10] No longer need to ignore progress_message --- setup.cfg | 1 - 1 file changed, 1 deletion(-) diff --git a/setup.cfg b/setup.cfg index e711d88..6c3c8f9 100644 --- a/setup.cfg +++ b/setup.cfg @@ -46,7 +46,6 @@ filterwarnings = ignore:distutils Version classes are deprecated:DeprecationWarning ignore:'imghdr' is deprecated and slated for removal in Python 3.13:DeprecationWarning ignore:The alias 'sphinx\.util\.SkipProgressMessage' is deprecated - ignore:The alias 'sphinx\.util\.progress_message' is deprecated [flake8] max-line-length = 125 From d8aa71042c6c505b00f58df1fe806fc8cc5de5a5 Mon Sep 17 00:00:00 2001 From: "P. L. Lim" <2090236+pllim@users.noreply.github.com> Date: Fri, 20 Jan 2023 09:25:15 -0500 Subject: [PATCH 09/10] Nope still need it --- setup.cfg | 1 + 1 file changed, 1 insertion(+) diff --git a/setup.cfg b/setup.cfg index 6c3c8f9..e711d88 100644 --- a/setup.cfg +++ b/setup.cfg @@ -46,6 +46,7 @@ filterwarnings = ignore:distutils Version classes are deprecated:DeprecationWarning ignore:'imghdr' is deprecated and slated for removal in Python 3.13:DeprecationWarning ignore:The alias 'sphinx\.util\.SkipProgressMessage' is deprecated + ignore:The alias 'sphinx\.util\.progress_message' is deprecated [flake8] max-line-length = 125 From 941f6418f55586452088bf344927fe3f241e1e7c Mon Sep 17 00:00:00 2001 From: "P. L. Lim" <2090236+pllim@users.noreply.github.com> Date: Fri, 20 Jan 2023 09:42:43 -0500 Subject: [PATCH 10/10] I don't care about Apple products --- .github/workflows/ci_workflows.yml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/.github/workflows/ci_workflows.yml b/.github/workflows/ci_workflows.yml index 7d0e1ab..30465d0 100644 --- a/.github/workflows/ci_workflows.yml +++ b/.github/workflows/ci_workflows.yml @@ -52,9 +52,9 @@ jobs: toxenv: py310-test-sphinx61 # MacOS X - just the oldest, stable, and dev - - os: macos-latest - python-version: 3.7 - toxenv: py37-test-sphinx24 + #- os: macos-latest + # python-version: 3.7 + # toxenv: py37-test-sphinx24 - os: macos-latest python-version: 3.8 toxenv: py38-test-sphinx43-clocale