From 9423751645d27ae1146ca645431c368f09cb3b6c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marc-Andr=C3=A9=20Lureau?= Date: Sat, 9 Oct 2021 01:47:56 +0400 Subject: [PATCH] docs/sphinx: add 's' keyboard binding to focus search MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit This is pretty ubiquitous. ('/' is already taken by some browsers for quick search) Signed-off-by: Marc-André Lureau Reviewed-by: John Snow Reviewed-by: Paolo Bonzini --- 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 f536483bc3..3161b8b127 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 0000000000..71a8605305 --- /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(); + } +});