[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[PULL v2 08/11] docs/sphinx: add 's' keyboard binding to focus search
From: |
marcandre . lureau |
Subject: |
[PULL v2 08/11] docs/sphinx: add 's' keyboard binding to focus search |
Date: |
Mon, 8 Nov 2021 13:01:52 +0400 |
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
- [PULL v2 01/11] docs/sphinx: add loaded modules to generated depfile, (continued)
- [PULL v2 01/11] docs/sphinx: add loaded modules to generated depfile, marcandre . lureau, 2021/11/08
- [PULL v2 02/11] docs/sphinx: add static files to generated depfile, marcandre . lureau, 2021/11/08
- [PULL v2 03/11] docs/sphinx: add templates files to generated depfile, marcandre . lureau, 2021/11/08
- [PULL v2 04/11] tests/qapi-schema/meson: add depfile to sphinx doc, marcandre . lureau, 2021/11/08
- [PULL v2 05/11] meson: drop sphinx_extn_depends, marcandre . lureau, 2021/11/08
- [PULL v2 06/11] meson: drop sphinx_template_files, marcandre . lureau, 2021/11/08
- [PULL v2 07/11] docs/sphinx: set navigation_with_keys=True, marcandre . lureau, 2021/11/08
- [PULL v2 09/11] docs: remove non-reference uses of single backticks, marcandre . lureau, 2021/11/08
- [PULL v2 10/11] docs: (further) remove non-reference uses of single backticks, marcandre . lureau, 2021/11/08
- [PULL v2 11/11] docs/sphinx: change default role to "any", marcandre . lureau, 2021/11/08
- [PULL v2 08/11] docs/sphinx: add 's' keyboard binding to focus search,
marcandre . lureau <=
- Re: [PULL v2 00/11] Sphinx patches, Richard Henderson, 2021/11/08