Fix rendering of double colons in Sphinx roles with docutils 0.18+

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

.gitignore

@@ -25,3 +25,16 @@
 /Sphinx-3.1.1.tar.gz
 /Sphinx-3.1.2.tar.gz
 /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

Fix-double-colons-with-docutils-0.18.patch

@@ -0,0 +1,27 @@
+From 4b482334a28d0706ba4bd68d51be9c041c135798 Mon Sep 17 00:00:00 2001
+From: =?UTF-8?q?Jean-Fran=C3=A7ois=20B?=
+ <2589111+jfbu@users.noreply.github.com>
+Date: Sat, 25 Jun 2022 21:10:34 +0200
+Subject: [PATCH] Fix duplicated field term colons for Docutils 0.18+ (#10595)
+
+Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
+---
+ sphinx/themes/basic/static/basic.css_t | 2 ++
+ 2 files changed, 4 insertions(+)
+
+diff --git a/sphinx/themes/basic/static/basic.css_t b/sphinx/themes/basic/static/basic.css_t
+index d8f3fe74626..47f802dc4e7 100644
+--- a/sphinx/themes/basic/static/basic.css_t
++++ b/sphinx/themes/basic/static/basic.css_t
+@@ -686,9 +686,11 @@ dl.field-list > dt {
+     padding-right: 5px;
+ }
+ 
++{%- if docutils_version_info[:2] < (0, 18) %}
+ dl.field-list > dt:after {
+     content: ":";
+ }
++{% endif %}
+ 
+ dl.field-list > dd {
+     padding-left: 0.5em;

python-sphinx.spec

@@ -4,6 +4,9 @@
 # Also, we don't have all the tests requirements
 %bcond_without tests
 
+# Unset -s on python shebang to allow RPM-installed sphinx to be used
+# with user-installed modules (#1903763)
+%global py3_shebang_flags %(echo %py3_shebang_flags | sed s/s//)
 
 # No internet in Koji
 %bcond_with internet
@@ -21,11 +24,11 @@
 %global upstream_name Sphinx
 
 Name:       python-sphinx
-%global     general_version 3.2.1
+%global     general_version 5.0.2
 #global     prerel ...
 %global     upstream_version %{general_version}%{?prerel}
 Version:    %{general_version}%{?prerel:~%{prerel}}
-Release:    1%{?dist}
+Release:    3%{?dist}
 Epoch:      1
 Summary:    Python documentation generator
 
@@ -42,25 +45,17 @@ Source0:    %{pypi_source %{upstream_name} %{upstream_version}}
 # which causes that test to fail.
 Patch1:     sphinx-test_theming.diff
 
+# Fix double colon rendering in Sphinx roles
+# This was supposed to get to Sphinx 5.0.3 but it was never released
+# Backporting per request: https://bugzilla.redhat.com/show_bug.cgi?id=2166116
+# Upstream: https://github.com/sphinx-doc/sphinx/issues/10594
+Patch2:     Fix-double-colons-with-docutils-0.18.patch
+
 BuildArch:     noarch
 
+BuildRequires: make
 BuildRequires: python%{python3_pkgversion}-devel
-BuildRequires: python%{python3_pkgversion}-setuptools
-
-BuildRequires: python%{python3_pkgversion}-babel
-BuildRequires: python%{python3_pkgversion}-docutils
-BuildRequires: python%{python3_pkgversion}-imagesize
-BuildRequires: python%{python3_pkgversion}-jinja2
-BuildRequires: python%{python3_pkgversion}-packaging
-BuildRequires: python%{python3_pkgversion}-pygments
-BuildRequires: python%{python3_pkgversion}-requests
-BuildRequires: python%{python3_pkgversion}-sphinxcontrib-applehelp
-BuildRequires: python%{python3_pkgversion}-sphinxcontrib-devhelp
-BuildRequires: python%{python3_pkgversion}-sphinxcontrib-htmlhelp
-BuildRequires: python%{python3_pkgversion}-sphinxcontrib-jsmath
-BuildRequires: python%{python3_pkgversion}-sphinxcontrib-qthelp
-BuildRequires: python%{python3_pkgversion}-sphinxcontrib-serializinghtml
-BuildRequires: python%{python3_pkgversion}-sphinx-theme-alabaster
+BuildRequires: pyproject-rpm-macros
 
 %if %{with websupport}
 BuildRequires: python%{python3_pkgversion}-sphinxcontrib-websupport
@@ -73,11 +68,7 @@ BuildRequires: dos2unix
 # tests import _testcapi
 BuildRequires: python%{python3_pkgversion}-test
 
-BuildRequires: python%{python3_pkgversion}-html5lib
-BuildRequires: python%{python3_pkgversion}-mock
-BuildRequires: python%{python3_pkgversion}-pytest
-BuildRequires: python%{python3_pkgversion}-snowballstemmer
-
+BuildRequires: gcc
 BuildRequires: gettext
 BuildRequires: graphviz
 BuildRequires: texinfo
@@ -154,22 +145,12 @@ Summary:       Python documentation generator
 
 Recommends:    graphviz
 Recommends:    ImageMagick
-%{?python_provide:%python_provide python%{python3_pkgversion}-sphinx}
 
 # Bundled JavaScript
-Provides:      bundled(jquery) = 3.2.1
+Provides:      bundled(jquery) = 3.5.1
 Provides:      bundled(underscore) = 1.3.1
 Provides:      bundled(css3-mediaqueries) = 1.0
 
-# Remove in F33
-Obsoletes:     python-sphinx-locale < 1:2
-Provides:      python-sphinx-locale = %{epoch}:%{version}-%{release}
-Obsoletes:     python%{python3_pkgversion}-sphinxcontrib-napoleon < 0.3.0
-Provides:      python%{python3_pkgversion}-sphinxcontrib-napoleon = %{epoch}:%{version}-%{release}
-Conflicts:     python2-Sphinx < 1:2
-Conflicts:     python2-sphinx < 1:2
-Provides:      python(Sphinx) = %{epoch}:%{version}-%{release}
-
 %description -n python%{python3_pkgversion}-sphinx
 Sphinx is a tool that makes it easy to create intelligent and
 beautiful documentation for Python projects (or other documents
@@ -233,11 +214,8 @@ Requires:      tex(upquote.sty)
 Requires:      tex(utf8x.def)
 Requires:      tex(wrapfig.sty)
 
-%{?python_provide:%python_provide python%{python3_pkgversion}-sphinx-latex}
-
-# Remove in F33
-Obsoletes:     python-sphinx-latex < 1:2
-Provides:      python-sphinx-latex = %{epoch}:%{version}-%{release}
+# No files in this package, automatic provides don't work:
+%py_provides   python%{python3_pkgversion}-sphinx-latex
 
 %description  -n python%{python3_pkgversion}-sphinx-latex
 Sphinx is a tool that makes it easy to create intelligent and
@@ -277,13 +255,22 @@ 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 -r %{?with_tests:-x test}
+
 
 %build
-%py3_build
+%pyproject_wheel
 
 export PYTHONPATH=$PWD
 pushd doc
-export SPHINXBUILD="%{__python3} ../sphinx/cmd/build.py"
+export SPHINXBUILD="%{python3} ../sphinx/cmd/build.py"
 make html SPHINXBUILD="$SPHINXBUILD"
 make man SPHINXBUILD="$SPHINXBUILD"
 rm -rf _build/html/.buildinfo
@@ -292,7 +279,7 @@ popd
 
 
 %install
-%py3_install
+%pyproject_install
 
 # For backwards compatibility. Remove with care, if at all
 for i in sphinx-{apidoc,autogen,build,quickstart}; do
@@ -366,7 +353,7 @@ mkdir %{buildroot}%{python3_sitelib}/sphinxcontrib
 %{_bindir}/sphinx-*
 %{python3_sitelib}/sphinx/
 %dir %{python3_sitelib}/sphinxcontrib/
-%{python3_sitelib}/Sphinx-%{upstream_version}-py%{python3_version}.egg-info/
+%{python3_sitelib}/Sphinx-%{upstream_version}.dist-info/
 %dir %{_datadir}/sphinx/
 %dir %{_datadir}/sphinx/locale
 %dir %{_datadir}/sphinx/locale/*
@@ -383,6 +370,101 @@ mkdir %{buildroot}%{python3_sitelib}/sphinxcontrib
 
 
 %changelog
+* Wed Feb 01 2023 Karolina Surma <ksurma@redhat.com> - 1:5.0.2-3
+- Backport a fix for rendering double colons in Sphinx roles
+- Fixes: rhbz#2166116
+
+* 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
+
+* Tue Jan 19 2021 Charalampos Stratakis <cstratak@redhat.com> - 1:3.4.3-1
+- Update to 3.4.3
+- Fixes rhbz#1909494
+
+* Sat Dec 05 2020 Mattia Verga <mattia.verga@protonmail.com> - 1:3.3.1-2
+- Unset -s from python shebang
+- Fixes: rhbz#1903763
+
+* Mon Nov 23 2020 Miro Hrončok <mhroncok@redhat.com> - 1:3.3.1-1
+- Update to 3.3.1
+- Fixes: rhbz#1893752
+
+* Wed Oct 14 2020 Tomas Hrnciar <thrnciar@redhat.com> - 1:3.2.1-2
+- Backport commit to fix python-sphinx with python-pygments v2.7.1
+
 * Tue Aug 18 2020 Miro Hrončok <mhroncok@redhat.com> - 1:3.2.1-1
 - Update to 3.2.1
 - Remove compatibility symbolic links from /usr/libexec/

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.2.1.tar.gz) = 3f0f49036a44938abd470c2f825a0eeeeb818daf3dfbb3bc5c746b64305b5fe66c1c34d9703eb9420b2b347247c122825ddae1b6c28c88c249206151f39e3bdb
+SHA512 (Sphinx-5.0.2.tar.gz) = d564697f0b82a9a59dd6a81e7822dbeac00fb6cc98cdc2422f04ec87c5133b5e03057ccdfdcfe38dccff41f6c53262d49f4ee6f77047c579aa2e55370bfe2dc6

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'