From: "Volker Rümelin" <vr_qemu@t-online.de>
To: Peter Maydell <peter.maydell@linaro.org>
Cc: John Snow <jsnow@redhat.com>, qemu-devel@nongnu.org
Subject: [PATCH] docs: fix the html docs search function
Date: Wed, 17 Jul 2024 22:11:23 +0200 [thread overview]
Message-ID: <20240717201123.9742-1-vr_qemu@t-online.de> (raw)
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.
Signed-off-by: Volker Rümelin <vr_qemu@t-online.de>
---
docs/conf.py | 3 +++
1 file changed, 3 insertions(+)
diff --git a/docs/conf.py b/docs/conf.py
index 876f676881..2aedd407a0 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -62,6 +62,9 @@
# ones.
extensions = ['kerneldoc', 'qmp_lexer', 'hxtool', 'depfile', 'qapidoc']
+if sphinx.version_info[:3] >= (6, 0, 0):
+ extensions += ['sphinxcontrib.jquery']
+
if sphinx.version_info[:3] > (4, 0, 0):
tags.add('sphinx4')
extensions += ['dbusdoc']
--
2.35.3
next reply other threads:[~2024-07-17 20:12 UTC|newest]
Thread overview: 3+ messages / expand[flat|nested] mbox.gz Atom feed top
2024-07-17 20:11 Volker Rümelin [this message]
2024-07-18 9:17 ` [PATCH] docs: fix the html docs search function Peter Maydell
2024-07-18 19:33 ` Volker Rümelin
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=20240717201123.9742-1-vr_qemu@t-online.de \
--to=vr_qemu@t-online.de \
--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).