From: marcandre.lureau@redhat.com
To: qemu-devel@nongnu.org
Cc: "John Snow" <jsnow@redhat.com>,
"Peter Maydell" <peter.maydell@linaro.org>,
"Richard Henderson" <richard.henderson@linaro.org>,
"Marc-André Lureau" <marcandre.lureau@redhat.com>
Subject: [PULL 08/11] docs/sphinx: add 's' keyboard binding to focus search
Date: Fri, 5 Nov 2021 17:32:19 +0400 [thread overview]
Message-ID: <20211105133222.184722-9-marcandre.lureau@redhat.com> (raw)
In-Reply-To: <20211105133222.184722-1-marcandre.lureau@redhat.com>
From: Marc-André Lureau <marcandre.lureau@redhat.com>
This is pretty ubiquitous. ('/' is already taken by some browsers for
quick search)
Signed-off-by: Marc-André Lureau <marcandre.lureau@redhat.com>
Reviewed-by: John Snow <jsnow@redhat.com>
Reviewed-by: Paolo Bonzini <pbonzini@redhat.com>
---
docs/conf.py | 4 ++++
docs/sphinx-static/custom.js | 9 +++++++++
2 files changed, 13 insertions(+)
create mode 100644 docs/sphinx-static/custom.js
diff --git a/docs/conf.py b/docs/conf.py
index f536483bc3d5..3161b8b127c6 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -182,6 +182,10 @@
'theme_overrides.css',
]
+html_js_files = [
+ 'custom.js',
+]
+
html_context = {
"display_gitlab": True,
"gitlab_user": "qemu-project",
diff --git a/docs/sphinx-static/custom.js b/docs/sphinx-static/custom.js
new file mode 100644
index 000000000000..71a86053051b
--- /dev/null
+++ b/docs/sphinx-static/custom.js
@@ -0,0 +1,9 @@
+document.addEventListener('keydown', (event) => {
+ // find a better way to look it up?
+ let search_input = document.getElementsByName('q')[0];
+
+ if (event.code === 'KeyS' && document.activeElement !== search_input) {
+ event.preventDefault();
+ search_input.focus();
+ }
+});
--
2.33.0.721.g106298f7f9
next prev parent reply other threads:[~2021-11-05 13:46 UTC|newest]
Thread overview: 14+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-11-05 13:32 [PULL 00/11] Sphinx patches marcandre.lureau
2021-11-05 13:32 ` [PULL 01/11] docs/sphinx: add loaded modules to generated depfile marcandre.lureau
2021-11-05 13:32 ` [PULL 02/11] docs/sphinx: add static files " marcandre.lureau
2021-11-05 13:32 ` [PULL 03/11] docs/sphinx: add templates " marcandre.lureau
2021-11-05 13:32 ` [PULL 04/11] tests/qapi-schema/meson: add depfile to sphinx doc marcandre.lureau
2021-11-05 13:32 ` [PULL 05/11] meson: drop sphinx_extn_depends marcandre.lureau
2021-11-05 13:32 ` [PULL 06/11] meson: drop sphinx_template_files marcandre.lureau
2021-11-05 13:32 ` [PULL 07/11] docs/sphinx: set navigation_with_keys=True marcandre.lureau
2021-11-05 13:32 ` marcandre.lureau [this message]
2021-11-05 13:32 ` [PULL 09/11] docs: remove non-reference uses of single backticks marcandre.lureau
2021-11-05 13:32 ` [PULL 10/11] docs: (further) " marcandre.lureau
2021-11-05 13:32 ` [PULL 11/11] docs/sphinx: change default role to "any" marcandre.lureau
2021-11-05 18:07 ` [PULL 00/11] Sphinx patches Richard Henderson
2021-11-08 8:49 ` Marc-André Lureau
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=20211105133222.184722-9-marcandre.lureau@redhat.com \
--to=marcandre.lureau@redhat.com \
--cc=jsnow@redhat.com \
--cc=peter.maydell@linaro.org \
--cc=qemu-devel@nongnu.org \
--cc=richard.henderson@linaro.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).