Hello packagers,
The new major version of the popular documentation framework Sphinx has been recently released[0]. It brings many changes, among which there is support of docutils 0.18.1. We aim to update both packages together in Fedora Rawhide on **July 11th**.
As usual, an ongoing attempt to smoothly integrate the updates takes place using Copr[1]. There are some packages impacted with the new changes. Please take time to review an fix the package, or coordinate with the upstream.
If your package hasn't succeeded to build with Python 3.11 yet, we can't test whether it will work with this update.
Common issues and mitigation
- `None` is no longer accepted as value of `language` in conf.py Solution: Use `language = 'en'` instead.
- Build/ tests fail with: `AttributeError: 'path' object has no attribute 'text'` Solution: use `path.read_text()` instead
Test your package locally in mock using the provided test Copr
$ mock -r fedora-rawhide-x86_64 --addrepo=https://download.copr.fedorainfracloud.org/results/ksurma/sphinx-5/fedora-ra... --no-clean <your.src.rpm> $ mock -r fedora-rawhide-x86_64 --addrepo=https://download.copr.fedorainfracloud.org/results/ksurma/sphinx-5/fedora-ra... shell
Packages that pin Sphinx and docutils to lower versions than are about to be introduced, and will effectively stop working after the update has reached Rawhide:
Sphinx < 5: python-h2-0:4.1.0-7.fc37.src python-priority-0:2.0.0-7.fc37.src python-sphinx-panels-0:0.6.0-3.fc37.src python-sphinx-tabs-0:3.1.0-7.fc37.src python3-sphinxcontrib-zopeext-0:0.3.2-3.fc37.noarch
docutils < 0.18: python-sphinx-tabs-0:3.1.0-7.fc37.src python3-sphinx_rtd_theme-0:1.0.0-6.fc37.noarch
Full list of known affected packages
Maintainers by package: copr-keygen clime dturecek frostyx msuchy praiskup coq amdunn jjames diceware kushal kea fjanus mosvald zdohnal libcamera javierm liblognorm alakatos rsroka zfridric python-django bkabrda churchyard jdornak mrunge rdopiera salimma sgallagh python-graphviz eclipseo python-h2 eclipseo python-pikepdf qulogic zdohnal python-priority eclipseo python-sphinx-panels qulogic python-sphinx-tabs hobbes1069 python-sphinx_rtd_theme jjames ksurma piotrp python-sphinxcontrib-bibtex jjames python-sphinxcontrib-htmlhelp churchyard cstratak python-sphinxcontrib-jsmath churchyard cstratak python-sphinxcontrib-qthelp churchyard cstratak python-sphinxcontrib-zopeext jjames
Packages by maintainer: alakatos liblognorm amdunn coq bkabrda python-django churchyard python-django python-sphinxcontrib-htmlhelp python-sphinxcontrib-jsmath python-sphinxcontrib-qthelp clime copr-keygen cstratak python-sphinxcontrib-htmlhelp python-sphinxcontrib-jsmath python-sphinxcontrib-qthelp dturecek copr-keygen eclipseo python-graphviz python-h2 python-priority fjanus kea frostyx copr-keygen hobbes1069 python-sphinx-tabs javierm libcamera jdornak python-django jjames coq python-sphinx_rtd_theme python-sphinxcontrib-bibtex python-sphinxcontrib-zopeext ksurma python-sphinx_rtd_theme kushal diceware mosvald kea mrunge python-django msuchy copr-keygen piotrp python-sphinx_rtd_theme praiskup copr-keygen qulogic python-pikepdf python-sphinx-panels rdopiera python-django rsroka liblognorm salimma python-django sgallagh python-django zdohnal kea python-pikepdf zfridric liblognorm
Cheers, Karolina Surma
[0] https://www.sphinx-doc.org/en/master/changes.html [1] https://copr.fedorainfracloud.org/coprs/ksurma/sphinx-5/
On Thu, 30 Jun 2022, 17:35 Karolina Surma, ksurma@redhat.com wrote:
Hello packagers,
The new major version of the popular documentation framework Sphinx has been recently released[0]. It brings many changes, among which there is support of docutils 0.18.1. We aim to update both packages together in Fedora Rawhide on **July 11th**.
Common issues and mitigation
- `None` is no longer accepted as value of `language` in conf.py
Solution: Use `language = 'en'` instead.
- Build/ tests fail with: `AttributeError: 'path' object has no
attribute 'text'` Solution: use `path.read_text()` instead
Full list of known affected packages
eclipseo python-graphviz python-h2 python-priority
Hello,
If we fix the common issues in Rawhide, will these fixes work on Fedora 36 with older Sphinx/docutils?
Best regards,
Robert-André
Hi,
On 6/30/22 17:44, Bob Mauchin wrote:
On Thu, 30 Jun 2022, 17:35 Karolina Surma, <ksurma@redhat.com mailto:ksurma@redhat.com> wrote:
Hello packagers, The new major version of the popular documentation framework Sphinx has been recently released[0]. It brings many changes, among which there is support of docutils 0.18.1. We aim to update both packages together in Fedora Rawhide on **July 11th**. Common issues and mitigation - `None` is no longer accepted as value of `language` in conf.py Solution: Use `language = 'en'` instead. - Build/ tests fail with: `AttributeError: 'path' object has no attribute 'text'` Solution: use `path.read_text()` instead Full list of known affected packages eclipseo python-graphviz python-h2 python-priorityHello,
If we fix the common issues in Rawhide, will these fixes work on Fedora 36 with older Sphinx/docutils?
Best regards,
Robert-André
There is a good news.
`path.text()` has been deprecated since Sphinx 3 - the fix will work on all active Fedora branches.
Regarding the language, it hasn't been automatically set to `None` since at least Sphinx 2, but Sphinx 5 is the first one to enforce the string value there. Fixing it should also work with all active Fedora releases.
The other issues will have to be checked case by case.
Cheers, Karolina
On 6/30/22 5:34 PM, Karolina Surma ksurma@redhat.com wrote:
eclipseo python-graphviz python-h2 python-priority
python-h2 and python-priority are fixed in Rawhide. A fix was pushed for python-graphviz, it just needs Sphinx 5 in Rawhide to build.
Best regards,
Robert-André
Hello,
The packages have been updated in Fedora Rawhide. A big thank you to everyone who helped mitigate the impact of this update.
You can now test your packages using Koji scratch build as you're used to. $ koji build --scratch rawhide <srpm>
There are still some packages with open Bugzilla tickets. If you're a maintainer of such package, please take a look at it.
Lastly, in case of troubles feel free to reach me through this thread or ping on #fedora-python on libera.chat (ksurma). I'll try to be of help as much as I can.
Cheers, Karolina
On 6/30/22 17:34, Karolina Surma wrote:
Hello packagers,
The new major version of the popular documentation framework Sphinx has been recently released[0]. It brings many changes, among which there is support of docutils 0.18.1. We aim to update both packages together in Fedora Rawhide on **July 11th**.
As usual, an ongoing attempt to smoothly integrate the updates takes place using Copr[1]. There are some packages impacted with the new changes. Please take time to review an fix the package, or coordinate with the upstream.
If your package hasn't succeeded to build with Python 3.11 yet, we can't test whether it will work with this update.
Common issues and mitigation
- `None` is no longer accepted as value of `language` in conf.py
Solution: Use `language = 'en'` instead.
- Build/ tests fail with: `AttributeError: 'path' object has no
attribute 'text'` Solution: use `path.read_text()` instead
Test your package locally in mock using the provided test Copr
$ mock -r fedora-rawhide-x86_64 --addrepo=https://download.copr.fedorainfracloud.org/results/ksurma/sphinx-5/fedora-ra... --no-clean <your.src.rpm> $ mock -r fedora-rawhide-x86_64 --addrepo=https://download.copr.fedorainfracloud.org/results/ksurma/sphinx-5/fedora-ra... shell
Packages that pin Sphinx and docutils to lower versions than are about to be introduced, and will effectively stop working after the update has reached Rawhide:
Sphinx < 5: python-h2-0:4.1.0-7.fc37.src python-priority-0:2.0.0-7.fc37.src python-sphinx-panels-0:0.6.0-3.fc37.src python-sphinx-tabs-0:3.1.0-7.fc37.src python3-sphinxcontrib-zopeext-0:0.3.2-3.fc37.noarch
docutils < 0.18: python-sphinx-tabs-0:3.1.0-7.fc37.src python3-sphinx_rtd_theme-0:1.0.0-6.fc37.noarch
Full list of known affected packages
Maintainers by package: copr-keygen clime dturecek frostyx msuchy praiskup coq amdunn jjames diceware kushal kea fjanus mosvald zdohnal libcamera javierm liblognorm alakatos rsroka zfridric python-django bkabrda churchyard jdornak mrunge rdopiera salimma sgallagh python-graphviz eclipseo python-h2 eclipseo python-pikepdf qulogic zdohnal python-priority eclipseo python-sphinx-panels qulogic python-sphinx-tabs hobbes1069 python-sphinx_rtd_theme jjames ksurma piotrp python-sphinxcontrib-bibtex jjames python-sphinxcontrib-htmlhelp churchyard cstratak python-sphinxcontrib-jsmath churchyard cstratak python-sphinxcontrib-qthelp churchyard cstratak python-sphinxcontrib-zopeext jjames
Packages by maintainer: alakatos liblognorm amdunn coq bkabrda python-django churchyard python-django python-sphinxcontrib-htmlhelp python-sphinxcontrib-jsmath python-sphinxcontrib-qthelp clime copr-keygen cstratak python-sphinxcontrib-htmlhelp python-sphinxcontrib-jsmath python-sphinxcontrib-qthelp dturecek copr-keygen eclipseo python-graphviz python-h2 python-priority fjanus kea frostyx copr-keygen hobbes1069 python-sphinx-tabs javierm libcamera jdornak python-django jjames coq python-sphinx_rtd_theme python-sphinxcontrib-bibtex python-sphinxcontrib-zopeext ksurma python-sphinx_rtd_theme kushal diceware mosvald kea mrunge python-django msuchy copr-keygen piotrp python-sphinx_rtd_theme praiskup copr-keygen qulogic python-pikepdf python-sphinx-panels rdopiera python-django rsroka liblognorm salimma python-django sgallagh python-django zdohnal kea python-pikepdf zfridric liblognorm
Cheers, Karolina Surma
[0] https://www.sphinx-doc.org/en/master/changes.html [1] https://copr.fedorainfracloud.org/coprs/ksurma/sphinx-5/
devel@lists.stg.fedoraproject.org
-
Bob Mauchin -
Karolina Surma -
zebob.m＠gmail.com