PR#45: Update to 5.1.1 - rpms/python-sphinx

rpms / python-sphinx

#45 Update to 5.1.1

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

rpms/ ksurma/python-sphinx 5.1.1 into rawhide

Remove duplicate files from the built documentation

Karolina Surma • 2 years ago

9c0d32b

Remove reST docs from the -doc package, ship only HTML

Karolina Surma • 2 years ago

9104ffe

Update to 5.1.1

Karolina Surma • 2 years ago

2da599d

.gitignore

file modified

		`@@ -38,3 +38,4 @@`
		`/Sphinx-4.4.0.tar.gz`
		`/Sphinx-4.5.0.tar.gz`
		`/Sphinx-5.0.2.tar.gz`
		`+ /Sphinx-5.1.1.tar.gz`

python-sphinx.spec

file modified

+13 -10

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

		`Name: python-sphinx`
		`- %global general_version 5.0.2`
		`+ %global general_version 5.1.1`
		`#global prerel ...`
		`%global upstream_version %{general_version}%{?prerel}`
		`Version: %{general_version}%{?prerel:~%{prerel}}`
		`- Release: 2%{?dist}`
		`+ Release: 1%{?dist}`
		`Epoch: 1`
		`Summary: Python documentation generator`

		`@@ -236,7 +236,7 @@`
		`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`
		`@@ -268,6 +268,10 @@`
		`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 @@`
		`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}`
		`@@ -360,10 +358,15 @@`

		`%files doc`
		`%license LICENSE`
		`- %doc html reST`
		`+ %doc html`


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

sources

file modified

+1 -1

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

ksurma commented 2 years ago

Impact check runs in Copr: https://copr.fedorainfracloud.org/coprs/ksurma/sphinx-5.1.1
Identified one Sphinx-related failure so far: python-sklearn-genetic-opt, will investigate how to fix.

rebased onto 2da599d

2 years ago

zuul commented 2 years ago

Build succeeded.

check-for-arches : SUCCESS in 56s
rpm-scratch-build : SUCCESS in 11m 45s
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 : FAILURE in 2m 38s (non-voting)
rpm-rpminspect : FAILURE in 4m 15s (non-voting)
check-for-tests : SUCCESS in 21s
check-for-sti-tests : SUCCESS in 22s
check-for-fmf-tests : SUCCESS in 22s
rpm-install-test : SUCCESS in 4m 02s
rpm-test : SKIPPED
rpm-tmt-test : SKIPPED
rpm-sti-test : SKIPPED

ksurma commented 2 years ago

rpmlinter and rpminspect fail.

rpminspect doesn't recognize Python license - it checks against the SPDX standard, but in our list of the allowed licenses I can't find the proper replacement for it in the official table: https://docs.fedoraproject.org/en-US/legal/allowed-licenses/ PSF-2.0 was added to fedora-license-data 2 weeks ago, but it seems not to have been released yet. I'd not block the update here.

rpmlinter warns about the file duplicates - which leads me to the question why do we ship ReST folder with the -doc subpackage. I'm inclined to nuke the rst sources from that package and leave the built html only.

I created a BZ for python-sklearn-genetic-opt: https://bugzilla.redhat.com/show_bug.cgi?id=2119288 - the pdf build fails but even after comparing the output and skimming through the logs I can't figure it out on my own.

No more issues were found in the impact check.

ksurma commented 2 years ago

Ad license: omg, this is even more complicated https://gitlab.com/fedora/legal/fedora-license-data/-/merge_requests/12

churchyard commented 2 years ago

rpmlinter warns about the file duplicates - which leads me to the question why do we ship ReST folder with the -doc subpackage. I'm inclined to nuke the rst sources from that package and leave the built html only.

yes please!

music commented 2 years ago

The python-sklearn-genetic-opt regression is caused by https://github.com/spatialaudio/nbsphinx/issues/656.

https://bugzilla.redhat.com/show_bug.cgi?id=2119288#c1

2 new commits added

Remove duplicate files from the built documentation
Remove reST docs from the -doc package, ship only HTML

2 years ago

zuul commented 2 years ago

Build succeeded.

check-for-arches : SUCCESS in 57s
rpm-scratch-build : SUCCESS in 12m 48s
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 36s (non-voting)
rpm-rpminspect : FAILURE in 4m 07s (non-voting)
check-for-tests : SUCCESS in 22s
check-for-sti-tests : SUCCESS in 23s
check-for-fmf-tests : SUCCESS in 22s
rpm-install-test : SUCCESS in 3m 21s
rpm-test : SKIPPED
rpm-tmt-test : SKIPPED
rpm-sti-test : SKIPPED

ksurma commented 2 years ago

The python-sklearn-genetic-opt regression is caused by https://github.com/spatialaudio/nbsphinx/issues/656.

https://bugzilla.redhat.com/show_bug.cgi?id=2119288#c1

Thank you for the pointer. I built the latest nbsphinx with the change from the open PR and built python-skleran-genetic-opt on top with a good result. I checked the resulting PDF, it looks like the missing elements were rendered fine. The build is here: https://copr.fedorainfracloud.org/coprs/ksurma/sphinx-5.1.1/build/4758974/

The related update of python-nbsphinx https://src.fedoraproject.org/rpms/python-nbsphinx/pull-request/8

With this one, I'd say this PR is finally ready.