From: Markus Armbruster <armbru@redhat.com>
To: John Snow <jsnow@redhat.com>
Cc: Akihiko Odaki <akihiko.odaki@daynix.com>,
Peter Maydell <peter.maydell@linaro.org>,
qemu-devel@nongnu.org, devel@daynix.com
Subject: Re: [PATCH 1/2] docs: Bump sphinx to 8.2.3
Date: Wed, 07 May 2025 07:22:49 +0200 [thread overview]
Message-ID: <871pt1ngeu.fsf@pond.sub.org> (raw)
In-Reply-To: <CAFn=p-bSMFVScSNewv_92-3u2FyyN5CYpUkABppazW53CUF-jw@mail.gmail.com> (John Snow's message of "Tue, 6 May 2025 15:42:49 -0400")
John Snow <jsnow@redhat.com> writes:
> On Mon, May 5, 2025 at 8:19 AM Akihiko Odaki <akihiko.odaki@daynix.com>
> wrote:
>
>> sphinx 5.3.0 fails with Python 3.13.1:
>>
>> ../docs/meson.build:37: WARNING:
>> /home/me/qemu/build/pyvenv/bin/sphinx-build:
>> Extension error:
>> Could not import extension sphinx.builders.epub3 (exception: No module
>> named 'imghdr')
>>
>> ../docs/meson.build:39:6: ERROR: Problem encountered: Install a Python 3
>> version of python-sphinx and the readthedoc theme
>>
>> Bump sphinx to 8.2.3 and also sphinx_rtd_theme as required for the new
>> sphinx version.
>>
>> Signed-off-by: Akihiko Odaki <akihiko.odaki@daynix.com>
[...]
> Can we set our suggested version to 6.2.0 instead? This version removed
> reliance on 'imghdr' but merely requires Python 3.8+ which is our current
> stated minimum.
>
> If Thomas upgrades our minimum Python to 3.9, then we could use something
> as new as 7.2.0 which requires 3.9+.
Thomas did: commit d64db833d6.
> I'd say 8.0.0 is too new (requires 3.10+) and conflicts with our stated
> minimums.
Requiring more recent versions of dependencies for optional parts of the
build can be okay, but the degradation must be graceful.
This makes sense only when the more recent dependencies save us enough
trouble to justify inconveniencing users stuck on older dependencies as
well as the additional build system complexity.
I have no opinion on whether that's the case here. If you think it is,
make your argument :)
"Graceful" means that if we require Sphinx 8, which requires Python
3.10, the build must still succeed when we have only Python 3.9 (our
stated minimum), but we don't build documentation then. If the user
demands documentation with configure --enable-docs, the build fails.
[...]
next prev parent reply other threads:[~2025-05-07 5:23 UTC|newest]
Thread overview: 10+ messages / expand[flat|nested] mbox.gz Atom feed top
2025-05-05 12:19 [PATCH 0/2] docs: Bump sphinx to 8.2.3 Akihiko Odaki
2025-05-05 12:19 ` [PATCH 1/2] " Akihiko Odaki
2025-05-06 19:42 ` John Snow
2025-05-07 5:22 ` Markus Armbruster [this message]
2025-05-07 18:23 ` John Snow
2025-05-10 5:21 ` Akihiko Odaki
2025-05-05 12:19 ` [PATCH 2/2] MAINTAINERS: Add docs/requirements.txt Akihiko Odaki
2025-05-05 15:36 ` [PATCH 0/2] docs: Bump sphinx to 8.2.3 Paolo Bonzini
2025-05-05 23:05 ` John Snow
2025-05-06 3:18 ` Paolo Bonzini
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=871pt1ngeu.fsf@pond.sub.org \
--to=armbru@redhat.com \
--cc=akihiko.odaki@daynix.com \
--cc=devel@daynix.com \
--cc=jsnow@redhat.com \
--cc=peter.maydell@linaro.org \
--cc=qemu-devel@nongnu.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).