[PATCH] docs: bump sphinx_rtd_theme pin to fix --enable-docs build

Brian Cain posted 1 patch 2 weeks, 5 days ago
Patches applied successfully (tree, apply log)
git fetch https://github.com/patchew-project/qemu tags/patchew/20260906222926.3714852-1-brian.cain@oss.qualcomm.com
Maintainers: John Snow <jsnow@redhat.com>, Peter Maydell <peter.maydell@linaro.org>, Mauro Carvalho Chehab <mchehab+huawei@kernel.org>, Pierrick Bouvier <pierrick.bouvier@oss.qualcomm.com>, Paolo Bonzini <pbonzini@redhat.com>, "Alex Bennée" <alex.bennee@linaro.org>
docs/requirements.txt | 2 +-
pythondeps.toml       | 2 +-
2 files changed, 2 insertions(+), 2 deletions(-)
[PATCH] docs: bump sphinx_rtd_theme pin to fix --enable-docs build
Posted by Brian Cain 2 weeks, 5 days ago
pythondeps.toml and docs/requirements.txt pin sphinx==7.2.6 alongside
sphinx_rtd_theme==1.2.2, but 1.2.2 requires sphinx<7 on PyPI.

A fresh install of the docs group silently downgrades Sphinx to 6.2.1 to
satisfy that cap, which then fails Sphinx's own >=7.2.6 runtime check
in docs/meson.build.

sphinx_rtd_theme==2.0.0 is the first release that drops the sphinx<7 cap
and resolves cleanly against sphinx==7.2.6.

Signed-off-by: Brian Cain <brian.cain@oss.qualcomm.com>
---
 docs/requirements.txt | 2 +-
 pythondeps.toml       | 2 +-
 2 files changed, 2 insertions(+), 2 deletions(-)

diff --git a/docs/requirements.txt b/docs/requirements.txt
index c10c4cf7c91..509d56bd1e8 100644
--- a/docs/requirements.txt
+++ b/docs/requirements.txt
@@ -2,4 +2,4 @@
 # Should be in sync with the "installed" key of pythondeps.toml
 
 sphinx==7.2.6
-sphinx_rtd_theme==1.2.2
+sphinx_rtd_theme==2.0.0
diff --git a/pythondeps.toml b/pythondeps.toml
index e4c10d4a9f7..afb1364dd28 100644
--- a/pythondeps.toml
+++ b/pythondeps.toml
@@ -29,7 +29,7 @@ meson = { accepted = ">=1.12.0", installed = "1.12.0", canary = "meson" }
 [docs]
 # Please keep the installed versions in sync with docs/requirements.txt
 sphinx = { accepted = ">=7.2.6", installed = "7.2.6", canary = "sphinx-build" }
-sphinx_rtd_theme = { accepted = ">=1.2.2", installed = "1.2.2" }
+sphinx_rtd_theme = { accepted = ">=1.2.2", installed = "2.0.0" }
 
 # This test group is for dependencies required to run various tooling
 # and tests that should always be installed at configure time. It should
-- 
2.34.1

Re: [PATCH] docs: bump sphinx_rtd_theme pin to fix --enable-docs build
Posted by Mark Cave-Ayland 2 weeks, 3 days ago
On 06/09/2026 23:29, Brian Cain wrote:

> pythondeps.toml and docs/requirements.txt pin sphinx==7.2.6 alongside
> sphinx_rtd_theme==1.2.2, but 1.2.2 requires sphinx<7 on PyPI.
> 
> A fresh install of the docs group silently downgrades Sphinx to 6.2.1 to
> satisfy that cap, which then fails Sphinx's own >=7.2.6 runtime check
> in docs/meson.build.
> 
> sphinx_rtd_theme==2.0.0 is the first release that drops the sphinx<7 cap
> and resolves cleanly against sphinx==7.2.6.
> 
> Signed-off-by: Brian Cain <brian.cain@oss.qualcomm.com>
> ---
>   docs/requirements.txt | 2 +-
>   pythondeps.toml       | 2 +-
>   2 files changed, 2 insertions(+), 2 deletions(-)
> 
> diff --git a/docs/requirements.txt b/docs/requirements.txt
> index c10c4cf7c91..509d56bd1e8 100644
> --- a/docs/requirements.txt
> +++ b/docs/requirements.txt
> @@ -2,4 +2,4 @@
>   # Should be in sync with the "installed" key of pythondeps.toml
>   
>   sphinx==7.2.6
> -sphinx_rtd_theme==1.2.2
> +sphinx_rtd_theme==2.0.0
> diff --git a/pythondeps.toml b/pythondeps.toml
> index e4c10d4a9f7..afb1364dd28 100644
> --- a/pythondeps.toml
> +++ b/pythondeps.toml
> @@ -29,7 +29,7 @@ meson = { accepted = ">=1.12.0", installed = "1.12.0", canary = "meson" }
>   [docs]
>   # Please keep the installed versions in sync with docs/requirements.txt
>   sphinx = { accepted = ">=7.2.6", installed = "7.2.6", canary = "sphinx-build" }
> -sphinx_rtd_theme = { accepted = ">=1.2.2", installed = "1.2.2" }
> +sphinx_rtd_theme = { accepted = ">=1.2.2", installed = "2.0.0" }
>   
>   # This test group is for dependencies required to run various tooling
>   # and tests that should always be installed at configure time. It should

Reviewed-by: Mark Cave-Ayland <mark.caveayland@nutanix.com>

It would be good to get this queued to master soon as my local 
development setup is currently broken (particularly as I'm working on 
series that include documentation changes).


ATB,

Mark.
Re: [PATCH] docs: bump sphinx_rtd_theme pin to fix --enable-docs build
Posted by Peter Maydell 2 weeks, 3 days ago
On Wed, 9 Sept 2026 at 10:56, Mark Cave-Ayland
<mark.caveayland@nutanix.com> wrote:
>
> On 06/09/2026 23:29, Brian Cain wrote:
>
> > pythondeps.toml and docs/requirements.txt pin sphinx==7.2.6 alongside
> > sphinx_rtd_theme==1.2.2, but 1.2.2 requires sphinx<7 on PyPI.
> >
> > A fresh install of the docs group silently downgrades Sphinx to 6.2.1 to
> > satisfy that cap, which then fails Sphinx's own >=7.2.6 runtime check
> > in docs/meson.build.
> >
> > sphinx_rtd_theme==2.0.0 is the first release that drops the sphinx<7 cap
> > and resolves cleanly against sphinx==7.2.6.
> >
> > Signed-off-by: Brian Cain <brian.cain@oss.qualcomm.com>
> > ---
> >   docs/requirements.txt | 2 +-
> >   pythondeps.toml       | 2 +-
> >   2 files changed, 2 insertions(+), 2 deletions(-)
> >
> > diff --git a/docs/requirements.txt b/docs/requirements.txt
> > index c10c4cf7c91..509d56bd1e8 100644
> > --- a/docs/requirements.txt
> > +++ b/docs/requirements.txt
> > @@ -2,4 +2,4 @@
> >   # Should be in sync with the "installed" key of pythondeps.toml
> >
> >   sphinx==7.2.6
> > -sphinx_rtd_theme==1.2.2
> > +sphinx_rtd_theme==2.0.0
> > diff --git a/pythondeps.toml b/pythondeps.toml
> > index e4c10d4a9f7..afb1364dd28 100644
> > --- a/pythondeps.toml
> > +++ b/pythondeps.toml
> > @@ -29,7 +29,7 @@ meson = { accepted = ">=1.12.0", installed = "1.12.0", canary = "meson" }
> >   [docs]
> >   # Please keep the installed versions in sync with docs/requirements.txt
> >   sphinx = { accepted = ">=7.2.6", installed = "7.2.6", canary = "sphinx-build" }
> > -sphinx_rtd_theme = { accepted = ">=1.2.2", installed = "1.2.2" }
> > +sphinx_rtd_theme = { accepted = ">=1.2.2", installed = "2.0.0" }
> >
> >   # This test group is for dependencies required to run various tooling
> >   # and tests that should always be installed at configure time. It should
>
> Reviewed-by: Mark Cave-Ayland <mark.caveayland@nutanix.com>
>
> It would be good to get this queued to master soon as my local
> development setup is currently broken (particularly as I'm working on
> series that include documentation changes).

I've now applied this to master as a buildfix; thanks.

-- PMM
Re: [PATCH] docs: bump sphinx_rtd_theme pin to fix --enable-docs build
Posted by Mark Cave-Ayland 2 weeks, 3 days ago
On 09/09/2026 11:00, Peter Maydell wrote:

> On Wed, 9 Sept 2026 at 10:56, Mark Cave-Ayland
> <mark.caveayland@nutanix.com> wrote:
>>
>> On 06/09/2026 23:29, Brian Cain wrote:
>>
>>> pythondeps.toml and docs/requirements.txt pin sphinx==7.2.6 alongside
>>> sphinx_rtd_theme==1.2.2, but 1.2.2 requires sphinx<7 on PyPI.
>>>
>>> A fresh install of the docs group silently downgrades Sphinx to 6.2.1 to
>>> satisfy that cap, which then fails Sphinx's own >=7.2.6 runtime check
>>> in docs/meson.build.
>>>
>>> sphinx_rtd_theme==2.0.0 is the first release that drops the sphinx<7 cap
>>> and resolves cleanly against sphinx==7.2.6.
>>>
>>> Signed-off-by: Brian Cain <brian.cain@oss.qualcomm.com>
>>> ---
>>>    docs/requirements.txt | 2 +-
>>>    pythondeps.toml       | 2 +-
>>>    2 files changed, 2 insertions(+), 2 deletions(-)
>>>
>>> diff --git a/docs/requirements.txt b/docs/requirements.txt
>>> index c10c4cf7c91..509d56bd1e8 100644
>>> --- a/docs/requirements.txt
>>> +++ b/docs/requirements.txt
>>> @@ -2,4 +2,4 @@
>>>    # Should be in sync with the "installed" key of pythondeps.toml
>>>
>>>    sphinx==7.2.6
>>> -sphinx_rtd_theme==1.2.2
>>> +sphinx_rtd_theme==2.0.0
>>> diff --git a/pythondeps.toml b/pythondeps.toml
>>> index e4c10d4a9f7..afb1364dd28 100644
>>> --- a/pythondeps.toml
>>> +++ b/pythondeps.toml
>>> @@ -29,7 +29,7 @@ meson = { accepted = ">=1.12.0", installed = "1.12.0", canary = "meson" }
>>>    [docs]
>>>    # Please keep the installed versions in sync with docs/requirements.txt
>>>    sphinx = { accepted = ">=7.2.6", installed = "7.2.6", canary = "sphinx-build" }
>>> -sphinx_rtd_theme = { accepted = ">=1.2.2", installed = "1.2.2" }
>>> +sphinx_rtd_theme = { accepted = ">=1.2.2", installed = "2.0.0" }
>>>
>>>    # This test group is for dependencies required to run various tooling
>>>    # and tests that should always be installed at configure time. It should
>>
>> Reviewed-by: Mark Cave-Ayland <mark.caveayland@nutanix.com>
>>
>> It would be good to get this queued to master soon as my local
>> development setup is currently broken (particularly as I'm working on
>> series that include documentation changes).
> 
> I've now applied this to master as a buildfix; thanks.
Thanks Peter!


ATB,

Mark.
Re: [PATCH] docs: bump sphinx_rtd_theme pin to fix --enable-docs build
Posted by John Snow 2 weeks, 4 days ago
On Sun, Sep 6, 2026 at 6:29 PM Brian Cain <brian.cain@oss.qualcomm.com> wrote:
>
> pythondeps.toml and docs/requirements.txt pin sphinx==7.2.6 alongside
> sphinx_rtd_theme==1.2.2, but 1.2.2 requires sphinx<7 on PyPI.
>
> A fresh install of the docs group silently downgrades Sphinx to 6.2.1 to
> satisfy that cap, which then fails Sphinx's own >=7.2.6 runtime check
> in docs/meson.build.
>
> sphinx_rtd_theme==2.0.0 is the first release that drops the sphinx<7 cap
> and resolves cleanly against sphinx==7.2.6.

Thank you for catching this and writing a very targeted fix.

I did not notice the silent downgrade as I have sufficiently modern
releases on my base system which our build system happily used
instead, and none of our CI tests noticed. I'll have to invest some
time to ensure this is tested somewhere for the future.

>
> Signed-off-by: Brian Cain <brian.cain@oss.qualcomm.com>

Reviewed-by: John Snow <jsnow@redhat.com>

(I did not test this, but based on the failure logs I saw and the PyPI
version constraints for Sphinx, I believe this fix is appropriate.
Peter, would you be so kind as to take this patch directly as a build
fix? I am taking today off as a sick day and don't want a build
failure to linger.)

> ---
>  docs/requirements.txt | 2 +-
>  pythondeps.toml       | 2 +-
>  2 files changed, 2 insertions(+), 2 deletions(-)
>
> diff --git a/docs/requirements.txt b/docs/requirements.txt
> index c10c4cf7c91..509d56bd1e8 100644
> --- a/docs/requirements.txt
> +++ b/docs/requirements.txt
> @@ -2,4 +2,4 @@
>  # Should be in sync with the "installed" key of pythondeps.toml
>
>  sphinx==7.2.6
> -sphinx_rtd_theme==1.2.2
> +sphinx_rtd_theme==2.0.0
> diff --git a/pythondeps.toml b/pythondeps.toml
> index e4c10d4a9f7..afb1364dd28 100644
> --- a/pythondeps.toml
> +++ b/pythondeps.toml
> @@ -29,7 +29,7 @@ meson = { accepted = ">=1.12.0", installed = "1.12.0", canary = "meson" }
>  [docs]
>  # Please keep the installed versions in sync with docs/requirements.txt
>  sphinx = { accepted = ">=7.2.6", installed = "7.2.6", canary = "sphinx-build" }
> -sphinx_rtd_theme = { accepted = ">=1.2.2", installed = "1.2.2" }
> +sphinx_rtd_theme = { accepted = ">=1.2.2", installed = "2.0.0" }
>
>  # This test group is for dependencies required to run various tooling
>  # and tests that should always be installed at configure time. It should
> --
> 2.34.1
>
>
Re: [PATCH] docs: bump sphinx_rtd_theme pin to fix --enable-docs build
Posted by Peter Maydell 2 weeks, 4 days ago
On Tue, 8 Sept 2026 at 17:34, John Snow <jsnow@redhat.com> wrote:
>
> On Sun, Sep 6, 2026 at 6:29 PM Brian Cain <brian.cain@oss.qualcomm.com> wrote:
> >
> > pythondeps.toml and docs/requirements.txt pin sphinx==7.2.6 alongside
> > sphinx_rtd_theme==1.2.2, but 1.2.2 requires sphinx<7 on PyPI.
> >
> > A fresh install of the docs group silently downgrades Sphinx to 6.2.1 to
> > satisfy that cap, which then fails Sphinx's own >=7.2.6 runtime check
> > in docs/meson.build.
> >
> > sphinx_rtd_theme==2.0.0 is the first release that drops the sphinx<7 cap
> > and resolves cleanly against sphinx==7.2.6.
>
> Thank you for catching this and writing a very targeted fix.
>
> I did not notice the silent downgrade as I have sufficiently modern
> releases on my base system which our build system happily used
> instead, and none of our CI tests noticed. I'll have to invest some
> time to ensure this is tested somewhere for the future.
>
> >
> > Signed-off-by: Brian Cain <brian.cain@oss.qualcomm.com>
>
> Reviewed-by: John Snow <jsnow@redhat.com>
>
> (I did not test this, but based on the failure logs I saw and the PyPI
> version constraints for Sphinx, I believe this fix is appropriate.
> Peter, would you be so kind as to take this patch directly as a build
> fix? I am taking today off as a sick day and don't want a build
> failure to linger.)

Sure, I can do that. (Though I haven't seen much complaining, so
I expect most people, like you and me and the CI, have the sphinx and
rtd-theme installed on the host and dodged the bug :-))

-- PMM