[HEADS UP] Sphinx 5 and docutils 0.18.1 coming to Rawhide on July 11th

[Karolina Surma]

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-rawhide-x86_64/
--no-clean <your.src.rpm>
$ mock -r fedora-rawhide-x86_64
--addrepo=https://download.copr.fedorainfracloud.org/results/ksurma/sphinx-5/fedora-rawhide-x86_64/
 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/