Re: [PATCH] docs: fix the html docs search function

[Volker Rümelin]

Am 18.07.24 um 11:17 schrieb Peter Maydell:
> On Wed, 17 Jul 2024 at 21:11, Volker Rümelin <vr_qemu@t-online.de> wrote:
>> Fix the search function in Sphinx generated html docs when built
>> with Sphinx >= 6.0.0.
>>
>> Quote from the Sphinx blog at
>> https://blog.readthedocs.com/sphinx6-upgrade
>>
>> Sphinx 6 is out and has important breaking changes
>>
>> Bundled jQuery is removed. The JavaScript asset is easily added
>> back using the new extension sphinxcontrib-jquery. It is included
>> automatically by sphinx-rtd-theme, so if you are using our theme,
>> you will also continue to have jQuery available in your
>> documentation.
> We do use the sphinx-rtd-theme, though:
>  html_theme = 'sphinx_rtd_theme'
>
> so that release note suggests we shouldn't need to manually
> pull in sphinxcontrib-jquery ?

You are right. I had a broken version of the sphinx_rtd_theme (version
1.2.0). This is a known issue and my patch is not necessary.

With best regards,
Volker

>
> thanks
> -- PMM