PR#46: Update to 5.3.0 - rpms/python-sphinx

rpms / python-sphinx

#46 Update to 5.3.0

Merged 2 years ago by ksurma. Opened 2 years ago by ksurma.

rpms/ ksurma/python-sphinx 5.2.3 into rawhide

Karolina Surma • 2 years ago

d24b3b0

.gitignore

file modified

		`@@ -39,3 +39,5 @@`
		`/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`

python-sphinx.spec

file modified

+9 -8

		`@@ -24,7 +24,7 @@`
		`%global upstream_name Sphinx`

		`Name: python-sphinx`
		`- %global general_version 5.1.1`
		`+ %global general_version 5.3.0`
		`#global prerel ...`
		`%global upstream_version %{general_version}%{?prerel}`
		`Version: %{general_version}%{?prerel:~%{prerel}}`
		`@@ -249,11 +249,6 @@`
		`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}`
		`@@ -331,9 +326,11 @@`
		`%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`
		`@@ -345,7 +342,7 @@`
		`%{_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/*`
		`@@ -362,6 +359,10 @@`


		`%changelog`
		`+ * 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`

sources

file modified

+1 -1

		`@@ -1,1 +1,1 @@`
		`- SHA512 (Sphinx-5.1.1.tar.gz) = 82cb4c435b0f6cee6bf80b81028f06e425e3d6fb5614e64b1f5a8c715ece80b697b5b55e04f3afe26236bb4590de9cd41008d6480c4b3d895803d83e914afff3`
		`+ SHA512 (Sphinx-5.3.0.tar.gz) = cd2321409f7566c6333d6fc5c4eb4ed2d07490923b0c8762a31f062d9e5d86bbd9bd2c2bb3b93a00b37f31940173404dba8259de940fe402a248cf66a72cd7ae`

ksurma commented 2 years ago

This requires https://src.fedoraproject.org/rpms/python-imagesize/pull-request/2 to be available.
I'll run the impact check in Copr.

Sphinx has moved from setuptools to pyproject.toml and flit as the build backend. Patches to setup.py are no longer needed. We don't need to patch out pytest-cov and typed_ast from pyproject.toml, they're not dragged into the build environment anymore.

zuul commented 2 years ago

Build failed. More information on how to proceed and troubleshoot errors available at https://fedoraproject.org/wiki/Zuul-based-ci

check-for-arches : SUCCESS in 57s
rpm-scratch-build : FAILURE in 12m 11s
rpm-scratch-build-s390x : SKIPPED (non-voting)
rpm-scratch-build-ppc64le : SKIPPED (non-voting)
rpm-scratch-build-i686 : SKIPPED (non-voting)
rpm-scratch-build-aarch64 : SKIPPED (non-voting)
rpm-linter : SKIPPED (non-voting)
rpm-rpminspect : SKIPPED (non-voting)
check-for-tests : SKIPPED
check-for-sti-tests : SKIPPED
check-for-fmf-tests : SKIPPED
rpm-install-test : SKIPPED
rpm-test : SKIPPED
rpm-tmt-test : SKIPPED
rpm-sti-test : SKIPPED

ksurma commented 2 years ago

Preparing impact check here: https://copr.fedorainfracloud.org/coprs/ksurma/sphinx-5.2.3/

ksurma commented 2 years ago

Problems identified:
- python-myst-parser (failing test suite due to the new directives present in Sphinx), reported upstream
- bind fails to build docs - https://bugzilla.redhat.com/show_bug.cgi?id=2132928
- coq fails to build docs - while looking for clues upstream, found this: https://bugzilla.redhat.com/show_bug.cgi?id=2132567 - this is "solved": for now the docs are not shipped with the package

Sphinx 5.3.0 is scheduled for Oct 16th.

rebased onto 388efc1

2 years ago

zuul commented 2 years ago

Build failed. More information on how to proceed and troubleshoot errors available at https://fedoraproject.org/wiki/Zuul-based-ci

check-for-arches : POST_FAILURE in 58s
rpm-scratch-build : SUCCESS in 11m 42s
rpm-scratch-build-s390x : SKIPPED (non-voting)
rpm-scratch-build-ppc64le : SKIPPED (non-voting)
rpm-scratch-build-i686 : SKIPPED (non-voting)
rpm-scratch-build-aarch64 : SKIPPED (non-voting)
rpm-linter : SUCCESS in 2m 30s (non-voting)
rpm-rpminspect : SUCCESS in 4m 16s (non-voting)
check-for-sti-tests : SUCCESS in 24s
check-for-fmf-tests : SUCCESS in 21s
rpm-install-test : SUCCESS in 5m 12s
rpm-tmt-test : SKIPPED
rpm-sti-test : SKIPPED

ksurma commented 2 years ago

New Sphinx version, new interesting failures.

python-breathe: https://download.copr.fedorainfracloud.org/results/ksurma/sphinx-5.2.3/fedora-rawhide-x86_64/05025236-python-breathe/builder-live.log.gz
python-pybids: https://download.copr.fedorainfracloud.org/results/ksurma/sphinx-5.2.3/fedora-rawhide-x86_64/05025504-python-pybids/builder-live.log.gz
python3-docs: https://download.copr.fedorainfracloud.org/results/ksurma/sphinx-5.2.3/fedora-rawhide-x86_64/05025197-python3-docs/builder-live.log.gz
python-myst-parser: https://download.copr.fedorainfracloud.org/results/ksurma/sphinx-5.2.3/fedora-rawhide-x86_64/05025419-python-myst-parser/builder-live.log.gz

No package caps the runtime Sphinx requirement under 5.3.0

ksurma commented 2 years ago

recheck

zuul commented 2 years ago

Build succeeded.

check-for-arches : SUCCESS in 56s
rpm-scratch-build : SUCCESS in 11m 59s
rpm-scratch-build-s390x : SKIPPED (non-voting)
rpm-scratch-build-ppc64le : SKIPPED (non-voting)
rpm-scratch-build-i686 : SKIPPED (non-voting)
rpm-scratch-build-aarch64 : SKIPPED (non-voting)
rpm-linter : SUCCESS in 2m 39s (non-voting)
rpm-rpminspect : SUCCESS in 4m 16s (non-voting)
check-for-sti-tests : SUCCESS in 19s
check-for-fmf-tests : SUCCESS in 20s
rpm-install-test : SUCCESS in 3m 28s
rpm-tmt-test : SKIPPED
rpm-sti-test : SKIPPED

ksurma commented 2 years ago

python-myst-parser: https://src.fedoraproject.org/rpms/python-myst-parser/pull-request/12 - the tests compare a rendered HTML output which has changed in Sphinx 5.2+ after adding new directives. This is not a regression, test failure is reported upstream, therefore I think we're safe to skip the failing tests for now.

python-breathe: https://src.fedoraproject.org/rpms/python-breathe/pull-request/13 - upstream patch solves the issue

python-pybids - that's a failure happening for some time now: https://bugzilla.redhat.com/show_bug.cgi?id=2113646, not related to this update, athough related to Sphinx in general.

python3-docs: this is an upstream issue reported here: https://github.com/python/cpython/issues/98366 + this PR: https://github.com/python/cpython/pull/98437

ksurma commented 2 years ago

python-pybids is solved: https://bodhi.fedoraproject.org/updates/FEDORA-2022-309ce7cf56

This leaves python3-docs to deal with.

ksurma commented 2 years ago

python3-docs: upstream PR was merged to the 3.11 branch https://github.com/python/cpython/pull/98437 - so i expect this will start to work when 3.11.1 is out. We don't need to build the docs before then, right?

churchyard commented 2 years ago

so i expect this will start to work when 3.11.1 is out. We don't need to build the docs before then, right?

Correct.

churchyard commented 2 years ago

The change looks good. rpminspect reports no weirdness.

churchyard commented on line 27 of python-sphinx.spec 2 years ago

For reference, we've discovered with @ksurma that test_build_latex_doc also fails with internet.

rebased onto 30802d2

2 years ago

ksurma commented 2 years ago

For reference, we've discovered with @ksurma that test_build_latex_doc also fails with internet.

It downloads Python logo from the internet - that's one problem.
Another is the issue with lualatex which produces OK looking PDF output on the test files if invoked directly as lualatex sphinxtests.tex but fails with a spurious error message when invoked as '['lualatex', '--halt-on-error', '--interaction=nonstopmode', '-output-directory=lualatex', 'sphinxtests.tex']'. The nonstopmode seems to be the problem here. We decided not to investigate it further and just skip the test.