docs: Bump sphinx to 8.2.3

[PATCH 0/2] docs: Bump sphinx to 8.2.3

Posted by Akihiko Odaki 7 months, 2 weeks ago

Supersedes: <20250120-sphinx-v1-0-65151b4441ac@daynix.com>
("[PATCH 0/2] docs: Bump sphinx to 8.1.3")

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>
---
Akihiko Odaki (2):
      docs: Bump sphinx to 8.2.3
      MAINTAINERS: Add docs/requirements.txt

 MAINTAINERS           | 1 +
 docs/requirements.txt | 4 ++--
 pythondeps.toml       | 4 ++--
 3 files changed, 5 insertions(+), 4 deletions(-)
---
base-commit: 1da8f3a3c53b604edfe0d55e475102640490549e
change-id: 20250505-sphinx82-ebb3f0bde7d7

Best regards,
-- 
Akihiko Odaki <akihiko.odaki@daynix.com>

Re: [PATCH 0/2] docs: Bump sphinx to 8.2.3

Posted by Paolo Bonzini 7 months, 2 weeks ago

On 5/5/25 14:19, Akihiko Odaki wrote:
> Supersedes: <20250120-sphinx-v1-0-65151b4441ac@daynix.com>
> ("[PATCH 0/2] docs: Bump sphinx to 8.1.3")

Sphinx 8 requires Python 3.11 on the other hand; not an objection, just 
a reminder for myself to add a note to the Changelog if this patch is 
merged.

Paolo

> 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>
> ---
> Akihiko Odaki (2):
>        docs: Bump sphinx to 8.2.3
>        MAINTAINERS: Add docs/requirements.txt
> 
>   MAINTAINERS           | 1 +
>   docs/requirements.txt | 4 ++--
>   pythondeps.toml       | 4 ++--
>   3 files changed, 5 insertions(+), 4 deletions(-)
> ---
> base-commit: 1da8f3a3c53b604edfe0d55e475102640490549e
> change-id: 20250505-sphinx82-ebb3f0bde7d7
> 
> Best regards,

Re: [PATCH 0/2] docs: Bump sphinx to 8.2.3

Posted by John Snow 7 months, 2 weeks ago

On Mon, May 5, 2025 at 11:36 AM Paolo Bonzini <pbonzini@redhat.com> wrote:

> On 5/5/25 14:19, Akihiko Odaki wrote:
> > Supersedes: <20250120-sphinx-v1-0-65151b4441ac@daynix.com>
> > ("[PATCH 0/2] docs: Bump sphinx to 8.1.3")
>
> Sphinx 8 requires Python 3.11 on the other hand; not an objection, just
> a reminder for myself to add a note to the Changelog if this patch is
> merged.
>

What happens if you are using Python 3.9/3.10 but don't have a suitable
version of Sphinx on hand? I assume it will fail.

Re: [PATCH 0/2] docs: Bump sphinx to 8.2.3

Posted by Paolo Bonzini 7 months, 2 weeks ago

Il mar 6 mag 2025, 01:06 John Snow <jsnow@redhat.com> ha scritto:

>
>
> On Mon, May 5, 2025 at 11:36 AM Paolo Bonzini <pbonzini@redhat.com> wrote:
>
>> On 5/5/25 14:19, Akihiko Odaki wrote:
>> > Supersedes: <20250120-sphinx-v1-0-65151b4441ac@daynix.com>
>> > ("[PATCH 0/2] docs: Bump sphinx to 8.1.3")
>>
>> Sphinx 8 requires Python 3.11 on the other hand; not an objection, just
>> a reminder for myself to add a note to the Changelog if this patch is
>> merged.
>>
>
> What happens if you are using Python 3.9/3.10 but don't have a suitable
> version of Sphinx on hand? I assume it will fail.
>

Yes, you have to install it yourself (which is what has to be documented in
the release notes).

It does suck that Sphinx doesn't support a version that is perfectly
supported until October 2026, but at least the workaround is simple.

Paolo

>