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

.gitignore

@@ -38,8 +38,3 @@
 /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
-/Sphinx-6.1.3.tar.gz
-/Sphinx-6.2.1.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

@@ -1,47 +1,55 @@
-# When bootstrapping sphinx in Fedora, we don't yet have sphinxcontrib-websupport
+# When bootstrapping sphinx, we don't yet have sphinxcontrib-websupport
 # Without it we have warnings in docs, but it's not a hard dependency
-# We don't want to support sphinxcontrib-websupport in RHEL, hence disabling the dependency
-%bcond websupport %{undefined rhel}
+%bcond_without websupport
 # Also, we don't have all the tests requirements
-%bcond tests 1
+%bcond_without tests
 
 # Unset -s on python shebang to allow RPM-installed sphinx to be used
 # with user-installed modules (#1903763)
-%undefine _py3_shebang_s
+%global py3_shebang_flags %(echo %py3_shebang_flags | sed s/s//)
 
 # No internet in Koji
-%bcond internet 0
+%bcond_with internet
 
+%if 0%{?rhel} > 7
 # Build without BuildRequires ImageMagick, to skip imgconverter tests
-%bcond imagemagick_tests %{undefined rhel}
-# Same for filelock -- we don't want it in RHEL just to run a handful of tests here
-%bcond filelock_tests %{undefined rhel}
+%bcond_with imagemagick_tests
+%else
+%bcond_without imagemagick_tests
+%endif
 
 # During texlive updates, sometimes the latex environment is unstable
-%bcond latex_tests 1
+%bcond_without latex_tests
 
 %global upstream_name Sphinx
 
 Name:       python-sphinx
-%global     general_version 6.2.1
+%global     general_version 5.0.2
 #global     prerel ...
 %global     upstream_version %{general_version}%{?prerel}
 Version:    %{general_version}%{?prerel:~%{prerel}}
-Release:    4%{?dist}
+Release:    3%{?dist}
 Epoch:      1
 Summary:    Python documentation generator
 
-# Unless otherwise noted, the license for code is BSD-2-Clause
+# Unless otherwise noted, the license for code is BSD
+# sphinx/util/inspect.py has bits licensed with PSF license v2 (Python)
 # sphinx/themes/haiku/static/haiku.css_t has bits licensed with MIT
-License:    BSD-2-Clause AND MIT
+# JS: JQuery, Underscore, css3-mediaqueries are available under MIT
+License:    BSD and Python and MIT
 
 URL:        https://www.sphinx-doc.org/
-Source:     %{pypi_source %{upstream_name} %{upstream_version}}
+Source0:    %{pypi_source %{upstream_name} %{upstream_version}}
 
 # Allow extra themes to exist. We pull in python3-sphinx-theme-alabaster
 # which causes that test to fail.
-Patch:      sphinx-test_theming.diff
+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
 
@@ -53,6 +61,9 @@ BuildRequires: pyproject-rpm-macros
 BuildRequires: python%{python3_pkgversion}-sphinxcontrib-websupport
 %endif
 
+# for fixes
+BuildRequires: dos2unix
+
 %if %{with tests}
 # tests import _testcapi
 BuildRequires: python%{python3_pkgversion}-test
@@ -135,6 +146,10 @@ Summary:       Python documentation generator
 Recommends:    graphviz
 Recommends:    ImageMagick
 
+# Bundled JavaScript
+Provides:      bundled(jquery) = 3.5.1
+Provides:      bundled(underscore) = 1.3.1
+Provides:      bundled(css3-mediaqueries) = 1.0
 
 %description -n python%{python3_pkgversion}-sphinx
 Sphinx is a tool that makes it easy to create intelligent and
@@ -216,7 +231,7 @@ builder.
 
 %package doc
 Summary:       Documentation for %{name}
-License:       BSD-2-Clause
+License:       BSD
 Recommends:    python%{python3_pkgversion}-sphinx = %{epoch}:%{version}-%{release}
 
 %description doc
@@ -227,25 +242,24 @@ 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 the HTML format.
+This package contains documentation in reST and HTML formats.
 
 
 %prep
 %autosetup -n %{upstream_name}-%{upstream_version} -p1
 
+# fix line encoding of bundled jquery.js
+dos2unix -k ./sphinx/themes/basic/static/jquery.js
+
 %if %{without imagemagick_tests}
 rm tests/test_ext_imgconverter.py
 %endif
 
-%if %{without filelock_tests}
-sed -i '/filelock/d' pyproject.toml
-rm tests/test_build_linkcheck.py tests/test_ext_intersphinx.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
 
-%if %{defined rhel}
-# unwanted dependency in RHEL, https://bugzilla.redhat.com/show_bug.cgi?id=1945182
-sed -i '/html5lib/d' pyproject.toml
-%endif
 
 %generate_buildrequires
 %pyproject_buildrequires -r %{?with_tests:-x test}
@@ -260,10 +274,6 @@ 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
 
@@ -290,6 +300,12 @@ 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}
@@ -323,19 +339,9 @@ 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
-# In RHEL builds, skip tests which use html5lib (excluded above)
 %pytest \
-%if %{defined rhel}
-    --ignore tests/test_build_html.py \
-    --ignore tests/test_build_latex.py \
-    --ignore tests/test_build_texinfo.py \
-    --ignore tests/test_domain_std.py \
-    --ignore tests/test_smartquotes.py \
-%endif
 %if %{without internet}
-    -k "not linkcheck and not test_latex_images and not test_build_latex_doc" \
+    -k "not linkcheck and not test_latex_images" \
 %endif
 ;
 %endif
@@ -347,7 +353,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,54 +366,13 @@ mkdir %{buildroot}%{python3_sitelib}/sphinxcontrib
 
 %files doc
 %license LICENSE
-%doc html
+%doc html reST
 
 
 %changelog
-* Thu Jul 27 2023 Miro Hrončok <mhroncok@redhat.com> - 1:6.2.1-4
-- Don't use filelock to test this package on RHEL
-
-* Fri Jul 21 2023 Fedora Release Engineering <releng@fedoraproject.org> - 1:6.2.1-3
-- Rebuilt for https://fedoraproject.org/wiki/Fedora_39_Mass_Rebuild
-
-* Thu Jul 13 2023 Karolina Surma <ksurma@redhat.com> - 1:6.2.1-2
-- Don't use websupport to build documentation on RHEL
-
-* Mon Jun 26 2023 Karolina Surma <ksurma@redhat.com> - 1:6.2.1-1
-- Update to 6.2.1
-- Fixes rhbz#2188968
-
-* Fri Jun 16 2023 Python Maint <python-maint@redhat.com> - 1:6.1.3-4
-- Rebuilt for Python 3.12
-
-* Tue Jun 13 2023 Python Maint <python-maint@redhat.com> - 1:6.1.3-3
-- Bootstrap for Python 3.12
-
-* Wed May 31 2023 Yaakov Selkowitz <yselkowi@redhat.com> - 1:6.1.3-2
-- Avoid html5lib test dependency in RHEL builds
-
-* Fri Mar 10 2023 Karolina Surma <ksurma@redhat.com> - 1:6.1.3-1
-- Update to 6.1.3
-- Fixes rhbz#2135122
-
-* Thu Mar 09 2023 Karolina Surma <ksurma@redhat.com> - 1:5.3.0-4
-- Fix tests related to missing setuptools and Babel 2.12
-- Fixes rhbz#2176685
-
-* 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
+* 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

sources

@@ -1 +1 @@
-SHA512 (Sphinx-6.2.1.tar.gz) = 88daae1f9bacbf513c0db1e7d732104b00ac36803b82e253d14eda287b4d48cfa34d0ed90b13099748610f405dc8bdcc54c2d33002a27b970117baf93418a062
+SHA512 (Sphinx-5.0.2.tar.gz) = d564697f0b82a9a59dd6a81e7822dbeac00fb6cc98cdc2422f04ec87c5133b5e03057ccdfdcfe38dccff41f6c53262d49f4ee6f77047c579aa2e55370bfe2dc6