Fix tests failures with Pygments 2.14

Signed-off-by: Fedora Release Engineering <releng@fedoraproject.org>

.gitignore

@@ -27,3 +27,17 @@
 /Sphinx-3.2.1.tar.gz
 /Sphinx-3.3.1.tar.gz
 /Sphinx-3.4.3.tar.gz
+/Sphinx-3.5.2.tar.gz
+/Sphinx-3.5.3.tar.gz
+/Sphinx-3.5.4.tar.gz
+/Sphinx-4.0.2.tar.gz
+/Sphinx-4.1.2.tar.gz
+/Sphinx-4.2.0.tar.gz
+/Sphinx-4.3.0.tar.gz
+/Sphinx-4.3.1.tar.gz
+/Sphinx-4.4.0.tar.gz
+/Sphinx-4.5.0.tar.gz
+/Sphinx-5.0.2.tar.gz
+/Sphinx-5.1.1.tar.gz
+/Sphinx-5.2.3.tar.gz
+/Sphinx-5.3.0.tar.gz

fix-tests-with-pygments-2.14.patch

@@ -0,0 +1,114 @@
+From c3bf917fcf18c5211b220a7b294b7e6012c2d510 Mon Sep 17 00:00:00 2001
+From: Adam Turner <9087854+aa-turner@users.noreply.github.com>
+Date: Sun, 1 Jan 2023 19:17:03 +0000
+Subject: [PATCH] Fix tests for Pygments 2.14
+
+Pygments 2.14 was released on 01/01/2023 [0]
+
+[0]: https://pygments.org/docs/changelog/#version-2-14-0
+
+---
+ pyproject.toml             |  2 +-
+ tests/test_ext_viewcode.py | 27 +++++++++++++++++++--------
+ tests/test_intl.py         | 11 +++++++++--
+ 3 files changed, 29 insertions(+), 11 deletions(-)
+
+diff --git a/pyproject.toml b/pyproject.toml
+index 0e059b5..c02ce20 100644
+--- a/pyproject.toml
++++ b/pyproject.toml
+@@ -64,7 +64,7 @@ dependencies = [
+     "sphinxcontrib-serializinghtml>=1.1.5",
+     "sphinxcontrib-qthelp",
+     "Jinja2>=3.0",
+-    "Pygments>=2.12",
++    "Pygments>=2.13",
+     "docutils>=0.14,<0.20",
+     "snowballstemmer>=2.0",
+     "babel>=2.9",
+diff --git a/tests/test_ext_viewcode.py b/tests/test_ext_viewcode.py
+index 7750b8d..6d443d1 100644
+--- a/tests/test_ext_viewcode.py
++++ b/tests/test_ext_viewcode.py
+@@ -2,6 +2,7 @@
+ 
+ import re
+ 
++import pygments
+ import pytest
+ 
+ 
+@@ -31,14 +32,24 @@ def test_viewcode(app, status, warning):
+ 
+     result = (app.outdir / '_modules/spam/mod1.html').read_text(encoding='utf8')
+     result = re.sub('<span class=".*?">', '<span>', result)  # filter pygments classes
+-    assert ('<div class="viewcode-block" id="Class1"><a class="viewcode-back" '
+-            'href="../../index.html#spam.Class1">[docs]</a>'
+-            '<span>@decorator</span>\n'
+-            '<span>class</span> <span>Class1</span>'
+-            '<span>(</span><span>object</span><span>):</span>\n'
+-            '    <span>&quot;&quot;&quot;</span>\n'
+-            '<span>    this is Class1</span>\n'
+-            '<span>    &quot;&quot;&quot;</span></div>\n') in result
++    if pygments.__version__ >= '2.14.0':
++        assert ('<div class="viewcode-block" id="Class1"><a class="viewcode-back" '
++                'href="../../index.html#spam.Class1">[docs]</a>'
++                '<span>@decorator</span>\n'
++                '<span>class</span> <span>Class1</span>'
++                '<span>(</span><span>object</span><span>):</span>\n'
++                '<span>    </span><span>&quot;&quot;&quot;</span>\n'
++                '<span>    this is Class1</span>\n'
++                '<span>    &quot;&quot;&quot;</span></div>\n') in result
++    else:
++        assert ('<div class="viewcode-block" id="Class1"><a class="viewcode-back" '
++                'href="../../index.html#spam.Class1">[docs]</a>'
++                '<span>@decorator</span>\n'
++                '<span>class</span> <span>Class1</span>'
++                '<span>(</span><span>object</span><span>):</span>\n'
++                '    <span>&quot;&quot;&quot;</span>\n'
++                '<span>    this is Class1</span>\n'
++                '<span>    &quot;&quot;&quot;</span></div>\n') in result
+ 
+ 
+ @pytest.mark.sphinx('epub', testroot='ext-viewcode')
+diff --git a/tests/test_intl.py b/tests/test_intl.py
+index 796d95b..0c4b838 100644
+--- a/tests/test_intl.py
++++ b/tests/test_intl.py
+@@ -6,6 +6,7 @@ Runs the text builder in the test root.
+ import os
+ import re
+ 
++import pygments
+ import docutils
+ import pytest
+ from babel.messages import mofile, pofile
+@@ -1105,8 +1106,11 @@ def test_additional_targets_should_not_be_translated(app):
+     expected_expr = ("""<span class="n">literal</span>"""
+                      """<span class="o">-</span>"""
+                      """<span class="n">block</span>\n"""
+-                     """<span class="k">in</span> """
++                     """<span class="k">in</span>"""
++                     """<span class="w"> </span>"""
+                      """<span class="n">list</span>""")
++    if pygments.__version__ < '2.14.0':
++        expected_expr = expected_expr.replace("""<span class="w"> </span>""", ' ')
+     assert_count(expected_expr, result, 1)
+ 
+     # doctest block should not be translated but be highlighted
+@@ -1184,8 +1188,11 @@ def test_additional_targets_should_be_translated(app):
+     expected_expr = ("""<span class="no">LITERAL</span>"""
+                      """<span class="o">-</span>"""
+                      """<span class="no">BLOCK</span>\n"""
+-                     """<span class="no">IN</span> """
++                     """<span class="no">IN</span>"""
++                     """<span class="w"> </span>"""
+                      """<span class="no">LIST</span>""")
++    if pygments.__version__ < '2.14.0':
++        expected_expr = expected_expr.replace("""<span class="w"> </span>""", ' ')
+     assert_count(expected_expr, result, 1)
+ 
+     # doctest block should not be translated but be highlighted
+-- 
+2.39.1
+

python-sphinx.spec

@@ -6,7 +6,7 @@
 
 # Unset -s on python shebang to allow RPM-installed sphinx to be used
 # with user-installed modules (#1903763)
-%global py3_shebang_flags %nil
+%global py3_shebang_flags %(echo %py3_shebang_flags | sed s/s//)
 
 # No internet in Koji
 %bcond_with internet
@@ -24,11 +24,11 @@
 %global upstream_name Sphinx
 
 Name:       python-sphinx
-%global     general_version 3.4.3
+%global     general_version 5.3.0
 #global     prerel ...
 %global     upstream_version %{general_version}%{?prerel}
 Version:    %{general_version}%{?prerel:~%{prerel}}
-Release:    2%{?dist}
+Release:    3%{?dist}
 Epoch:      1
 Summary:    Python documentation generator
 
@@ -45,6 +45,11 @@ Source0:    %{pypi_source %{upstream_name} %{upstream_version}}
 # which causes that test to fail.
 Patch1:     sphinx-test_theming.diff
 
+# Backported upstream commit included in Sphinx 6+ ensures compatibility
+# with python-pygments 2.14+
+# https://github.com/sphinx-doc/sphinx/commit/965768bfda2a00ba6
+Patch2:     fix-tests-with-pygments-2.14.patch
+
 BuildArch:     noarch
 
 BuildRequires: make
@@ -236,7 +241,7 @@ Brandl. It was originally created to translate the new Python
 documentation, but has now been cleaned up in the hope that it will be
 useful to many other projects.
 
-This package contains documentation in reST and HTML formats.
+This package contains documentation in the HTML format.
 
 
 %prep
@@ -249,14 +254,9 @@ dos2unix -k ./sphinx/themes/basic/static/jquery.js
 rm tests/test_ext_imgconverter.py
 %endif
 
-# Don't measure coverage:
-sed -i '/pytest-cov/d' setup.py
-# Not needed on recent Pythons, https://github.com/sphinx-doc/sphinx/pull/8483
-sed -i '/typed_ast/d' setup.py
-
 
 %generate_buildrequires
-%pyproject_buildrequires %{?with_tests:-x test}
+%pyproject_buildrequires -r %{?with_tests:-x test}
 
 
 %build
@@ -268,6 +268,10 @@ export SPHINXBUILD="%{python3} ../sphinx/cmd/build.py"
 make html SPHINXBUILD="$SPHINXBUILD"
 make man SPHINXBUILD="$SPHINXBUILD"
 rm -rf _build/html/.buildinfo
+# Those files are copied to _build/html/_images and loaded to the
+# html pages from there - we can safely remove the duplicated and unused files
+rm -rf _build/html/_static/themes _build/html/_static/tutorial
+rm -f _build/html/_static/more.png _build/html/_static/translation.svg
 mv _build/html ..
 popd
 
@@ -294,12 +298,6 @@ do
 done
 popd
 
-# Deliver rst files
-rm -rf doc/_build
-sed -i 's|python ../sphinx-build.py|/usr/bin/sphinx-build|' doc/Makefile
-mv doc reST
-rm reST/make.bat
-
 # Move language files to /usr/share;
 # patch to support this incorporated in 0.6.6
 pushd %{buildroot}%{python3_sitelib}
@@ -333,9 +331,11 @@ mkdir %{buildroot}%{python3_sitelib}/sphinxcontrib
 %if %{with tests}
 %check
 # Currently, all linkcheck tests and test_latex_images need internet
+# test_build_latex_doc needs internet to download pictures,
+# but fails also with it enabled, we decided to skip it entirely
 %pytest \
 %if %{without internet}
-    -k "not linkcheck and not test_latex_images" \
+    -k "not linkcheck and not test_latex_images and not test_build_latex_doc" \
 %endif
 ;
 %endif
@@ -347,7 +347,7 @@ mkdir %{buildroot}%{python3_sitelib}/sphinxcontrib
 %{_bindir}/sphinx-*
 %{python3_sitelib}/sphinx/
 %dir %{python3_sitelib}/sphinxcontrib/
-%{python3_sitelib}/Sphinx-%{upstream_version}.dist-info/
+%{python3_sitelib}/sphinx-%{upstream_version}.dist-info/
 %dir %{_datadir}/sphinx/
 %dir %{_datadir}/sphinx/locale
 %dir %{_datadir}/sphinx/locale/*
@@ -360,10 +360,98 @@ mkdir %{buildroot}%{python3_sitelib}/sphinxcontrib
 
 %files doc
 %license LICENSE
-%doc html reST
+%doc html
 
 
 %changelog
+* Tue Jan 31 2023 Karolina Surma <ksurma@redhat.com> - 1:5.3.0-3
+- Fix tests with python-pygments 2.14+
+
+* Fri Jan 20 2023 Fedora Release Engineering <releng@fedoraproject.org> - 1:5.3.0-2
+- Rebuilt for https://fedoraproject.org/wiki/Fedora_38_Mass_Rebuild
+
+* Tue Nov 08 2022 Karolina Surma <ksurma@redhat.com> - 1:5.3.0-1
+- Update to 5.3.0
+- Fixes rhbz#2129546
+
+* Mon Aug 15 2022 Karolina Surma <ksurma@redhat.com> - 1:5.1.1-1
+- Update to 5.1.1
+- Fixes rhbz#2110473
+- Remove reST documentation from the -doc package, ship only HTML
+
+* Fri Jul 22 2022 Fedora Release Engineering <releng@fedoraproject.org> - 1:5.0.2-2
+- Rebuilt for https://fedoraproject.org/wiki/Fedora_37_Mass_Rebuild
+
+* Tue Jun 21 2022 Karolina Surma <ksurma@redhat.com> - 1:5.0.2-1
+- Update to 5.0.2
+
+* Mon Jun 13 2022 Python Maint <python-maint@redhat.com> - 1:4.5.0-3
+- Rebuilt for Python 3.11
+
+* Mon Jun 13 2022 Python Maint <python-maint@redhat.com> - 1:4.5.0-2
+- Bootstrap for Python 3.11
+
+* Fri Apr 01 2022 Karolina Surma <ksurma@redhat.com> - 1:4.5.0-1
+- Update to 4.5.0
+- Fixes rhbz#2068924
+
+* Tue Feb 01 2022 Karolina Surma <ksurma@redhat.com> - 1:4.4.0-1
+- Update to 4.4.0
+- Fixes rhbz#2033955
+
+* Fri Jan 21 2022 Fedora Release Engineering <releng@fedoraproject.org> - 1:4.3.1-2
+- Rebuilt for https://fedoraproject.org/wiki/Fedora_36_Mass_Rebuild
+
+* Mon Nov 29 2021 Karolina Surma <ksurma@redhat.com> - 1:4.3.1-1
+- Update to 4.3.1
+- Fixes rhbz#2027059
+
+* Fri Nov 19 2021 Karolina Surma <ksurma@redhat.com> - 1:4.3.0-1
+- Update to 4.3.0
+- Fixes rhbz#2022111
+
+* Fri Sep 17 2021 Karolina Surma <ksurma@redhat.com> - 1:4.2.0-1
+- Update to 4.2.0
+- Fixes rhbz#2003427
+
+* Thu Sep 16 2021 Karolina Surma <ksurma@redhat.com> - 1:4.1.2-3
+- Display typing objects correctly with Python 3.10 (fix FTBFS)
+- Generate correct reference to parent class if class has `_name` attribute
+- Enable previously deselected test
+
+* Wed Aug 18 2021 Karolina Surma <ksurma@redhat.com> - 1:4.1.2-2
+- Patch python-sphinx to work with python-pygments >=2.10
+
+* Mon Aug 02 2021 Karolina Surma <ksurma@redhat.com> - 1:4.1.2-1
+- Update to 4.1.2
+- Fixes rhbz#1979326
+- Backport commit to fix python-sphinx with Python 3.10-rc1
+
+* Fri Jul 23 2021 Fedora Release Engineering <releng@fedoraproject.org> - 1:4.0.2-4
+- Rebuilt for https://fedoraproject.org/wiki/Fedora_35_Mass_Rebuild
+
+* Fri Jun 11 2021 Karolina Surma <ksurma@redhat.com> - 1:4.0.2-1
+- Update to 4.0.2
+- Fixes rhbz#1948279
+
+* Thu Jun 03 2021 Python Maint <python-maint@redhat.com> - 1:3.5.4-3
+- Rebuilt for Python 3.10
+
+* Wed Jun 02 2021 Python Maint <python-maint@redhat.com> - 1:3.5.4-2
+- Bootstrap for Python 3.10
+
+* Mon May 10 2021 Karolina Surma <ksurma@redhat.com> - 1:3.5.4-1
+- Update to 3.5.4
+- Fixes rhbz#1949477
+
+* Thu Apr 01 2021 Karolina Surma <ksurma@redhat.com> - 1:3.5.3-1
+- Update to 3.5.3
+- Fixes rhbz#1941161
+
+* Wed Mar 10 2021 Charalampos Stratakis <cstratak@redhat.com> - 1:3.5.2-1
+- Update 3.5.2
+- Fixes rhbz#1928459
+
 * Wed Jan 27 2021 Fedora Release Engineering <releng@fedoraproject.org> - 1:3.4.3-2
 - Rebuilt for https://fedoraproject.org/wiki/Fedora_34_Mass_Rebuild
 

rpminspect.yaml

@@ -0,0 +1,4 @@
+# exclude XML template (not always valid) from XML validity check:
+xml:
+    ignore:
+        - /usr/lib/python*/site-packages/sphinx/themes/basic/opensearch.xml

sources

@@ -1 +1 @@
-SHA512 (Sphinx-3.4.3.tar.gz) = 2e085e00c722f3aaf34552eefc3842daf5443f7b8a11afa850db1e31ad81d5ff7f579622b91f982b21708fa6379907bac4fe72d42dc05859a3f62c75298facaa
+SHA512 (Sphinx-5.3.0.tar.gz) = cd2321409f7566c6333d6fc5c4eb4ed2d07490923b0c8762a31f062d9e5d86bbd9bd2c2bb3b93a00b37f31940173404dba8259de940fe402a248cf66a72cd7ae

sphinx-test_theming.diff

@@ -1,12 +1,12 @@
 diff -ru Sphinx-1.7.6/tests/test_theming.py Sphinx-1.7.6_patched/tests/test_theming.py
 --- Sphinx-1.7.6/tests/test_theming.py	2018-07-16 11:24:40.000000000 +0200
 +++ Sphinx-1.7.6_patched/tests/test_theming.py	2018-07-20 15:17:35.049263077 +0200
-@@ -31,7 +31,7 @@
+@@ -25,7 +25,7 @@
          themes.append('alabaster')
  
      # test Theme class API
--    assert set(app.html_themes.keys()) == set(themes)
-+    assert set(app.html_themes.keys()) >= set(themes)
-     assert app.html_themes['test-theme'] == app.srcdir / 'test_theme' / 'test-theme'
-     assert app.html_themes['ziptheme'] == app.srcdir / 'ziptheme.zip'
-     assert app.html_themes['staticfiles'] == app.srcdir / 'test_theme' / 'staticfiles'
+-    assert set(app.registry.html_themes.keys()) == set(themes)
++    assert set(app.registry.html_themes.keys()) >= set(themes)
+     assert app.registry.html_themes['test-theme'] == app.srcdir / 'test_theme' / 'test-theme'
+     assert app.registry.html_themes['ziptheme'] == app.srcdir / 'ziptheme.zip'
+     assert app.registry.html_themes['staticfiles'] == app.srcdir / 'test_theme' / 'staticfiles'