aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMarc-André Lureau <marcandre.lureau@redhat.com>2021-10-09 01:47:56 +0400
committerMarc-André Lureau <marcandre.lureau@redhat.com>2021-11-08 12:27:23 +0400
commit9423751645d27ae1146ca645431c368f09cb3b6c (patch)
tree3f1f5263f576b95b51db2564759e6d80929093bf
parent96871b38547211d8d91e7d059a3322e67b53657c (diff)
downloadqemu-9423751645d27ae1146ca645431c368f09cb3b6c.zip
qemu-9423751645d27ae1146ca645431c368f09cb3b6c.tar.gz
qemu-9423751645d27ae1146ca645431c368f09cb3b6c.tar.bz2
docs/sphinx: add 's' keyboard binding to focus search
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>
-rw-r--r--docs/conf.py4
-rw-r--r--docs/sphinx-static/custom.js9
2 files changed, 13 insertions, 0 deletions
diff --git a/docs/conf.py b/docs/conf.py
index f536483..3161b8b 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -182,6 +182,10 @@ html_css_files = [
'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 0000000..71a8605
--- /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();
+ }
+});