From f2192ebab397db69ef5a5281f855a7bbaa786a07 Mon Sep 17 00:00:00 2001 From: Rotzbua Date: Thu, 14 Sep 2023 11:35:38 +0200 Subject: [PATCH] Update dependencies according to breathe==4.35.0 --- .github/workflows/test_python.yaml | 37 ++++++++++++++++-------------- pyproject.toml | 4 ---- setup.cfg | 6 ++--- tox.ini | 5 +--- 4 files changed, 24 insertions(+), 28 deletions(-) diff --git a/.github/workflows/test_python.yaml b/.github/workflows/test_python.yaml index 12432c8..c4ae04c 100644 --- a/.github/workflows/test_python.yaml +++ b/.github/workflows/test_python.yaml @@ -63,23 +63,6 @@ jobs: - name: Install Python Tools run: | pip install -U pip tox codecov coverage - # Sphinx 3.0.0 ################################################################### - - name: Test Python ${{ matrix.python-version }} / sphinx==3.0.0 - env: - # NOTE: this is the current minimum supported. - SPHINX_VERSION: '==3.0.0' - run: | - tox -e py -- --cov-report xml:coverage.xml --cov - - name: Upload Code Coverage for Python ${{ matrix.python-version }} / sphinx==3.0.0 - run: | - codecov --required -X gcov -f coverage.xml --name "[GHA] ${{ matrix.os }}-py${{ matrix.python-version }}-sphinx3.0.0" - # Don't let code coverage utilities share anything, force clean it all. - - name: Cleanup Python ${{ matrix.python-version }} Testing / Coverage Artifacts - run: | - mv .gitignore nolongerignored - git clean -n - git clean -f - git reset --hard # Sphinx 4.x ##################################################################### - name: Test Python ${{ matrix.python-version }} / sphinx 4.x env: @@ -127,3 +110,23 @@ jobs: if: ${{ matrix.python-version != '3.7' }} run: | codecov --required -X gcov -f coverage.xml --name "[GHA] ${{ matrix.os }}-py${{ matrix.python-version }}-sphinx6.x" + # Don't let code coverage utilities share anything, force clean it all. + - name: Cleanup Python ${{ matrix.python-version }} Testing / Coverage Artifacts + run: | + mv .gitignore nolongerignored + git clean -n + git clean -f + git reset --hard + # Sphinx 7.x ##################################################################### + - name: Test Python ${{ matrix.python-version }} / sphinx 7.x + # sphinx 7.x requires python 3.9+ + if: ${{ matrix.python-version != '3.7' && matrix.python-version != '3.8' }} + env: + # Test sphinx <7.2. + SPHINX_VERSION: '>=7,<7.2' + run: | + tox -e py -- --cov-report xml:coverage.xml --cov + - name: Upload Code Coverage for Python ${{ matrix.python-version }} / sphinx 7.x + if: ${{ matrix.python-version != '3.7' && matrix.python-version != '3.8' }} + run: | + codecov --required -X gcov -f coverage.xml --name "[GHA] ${{ matrix.os }}-py${{ matrix.python-version }}-sphinx6.x" diff --git a/pyproject.toml b/pyproject.toml index 98799e1..8fe2d75 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -18,10 +18,6 @@ filterwarnings = [ "default::PendingDeprecationWarning", # Bypass docutils warning: DeprecationWarning: 'U' mode is deprecated "ignore::DeprecationWarning:docutils.io", - # Bypass breathe bug: - # RemovedInSphinx30Warning: function based directive support is now deprecated. - # Use class based directive instead. - "ignore::PendingDeprecationWarning:sphinx.util.docutils", ] ######################################################################################## diff --git a/setup.cfg b/setup.cfg index 200fac9..7bc63c3 100644 --- a/setup.cfg +++ b/setup.cfg @@ -36,11 +36,11 @@ zip_safe = False packages = find: # NOTE: making changes here? Please also update tox.ini [testenv{deps}]! install_requires = - # From breathe==4.32.0 + # From breathe==4.35.0 docutils>=0.12 - Sphinx>=3.0,<7 + Sphinx>=4.0,!=5.0.0 # For exhale - breathe>=4.32.0 + breathe>=4.35.0 beautifulsoup4 lxml # TODO: remove this dependency diff --git a/tox.ini b/tox.ini index f12ae29..0d9f934 100644 --- a/tox.ini +++ b/tox.ini @@ -13,12 +13,9 @@ skip_install = true # SPHINX_VERSION="==3.0.0" tox -e py # This way, if the variable is not set, it uses the latest version. deps = - # TODO: drop this when sphinx 3.x is dropped. - # https://github.com/sphinx-doc/sphinx/issues/10291 - Jinja2<3.1 # requirements for exhale sphinx{env:SPHINX_VERSION:} - breathe{env:BREATHE_VERSION:>=4.32.0} + breathe{env:BREATHE_VERSION:>=4.35.0} beautifulsoup4 # NOTE: for dev convenience, see https://github.com/svenevs/exhale/issues/131 lxml>=4.6.4