summary refs log tree commit diff stats
path: root/docs/system/linuxboot.rst
diff options
context:
space:
mode:
authorManos Pitsidianakis <manos.pitsidianakis@linaro.org>2025-07-10 11:45:29 +0100
committerAlex Bennée <alex.bennee@linaro.org>2025-07-14 11:42:49 +0100
commite962d3c921e00395a7d151adba617249b7579f7a (patch)
treeda5158421217ae3911b223209f5f75352ecb3987 /docs/system/linuxboot.rst
parentdcc83c3e41a89a1426fb56106c882479185f6383 (diff)
downloadfocaccia-qemu-e962d3c921e00395a7d151adba617249b7579f7a.tar.gz
focaccia-qemu-e962d3c921e00395a7d151adba617249b7579f7a.zip
docs: use :kbd: role in sphinx docs
Sphinx supports the :kbd: role for notating keyboard input. They get
formatted as <kbd> HTML elements in the readthedocs theme we currently
use for Sphinx.

Besides the better visual formatting, it also helps with accessibility
as screen readers can announce the semantics of the <kbd> element to the
user.

Signed-off-by: Manos Pitsidianakis <manos.pitsidianakis@linaro.org>
Message-ID: <20250709-docs_rst_improvements-v2-1-cb5096ad0022@linaro.org>
Signed-off-by: Alex Bennée <alex.bennee@linaro.org>
Message-ID: <20250710104531.3099313-7-alex.bennee@linaro.org>
Diffstat (limited to 'docs/system/linuxboot.rst')
-rw-r--r--docs/system/linuxboot.rst2
1 files changed, 1 insertions, 1 deletions
diff --git a/docs/system/linuxboot.rst b/docs/system/linuxboot.rst
index 2328b4a73d..f7573ab80a 100644
--- a/docs/system/linuxboot.rst
+++ b/docs/system/linuxboot.rst
@@ -26,5 +26,5 @@ virtual serial port and the QEMU monitor to the console with the
    |qemu_system| -kernel bzImage -drive file=rootdisk.img,format=raw \
                     -append "root=/dev/sda console=ttyS0" -nographic
 
-Use Ctrl-a c to switch between the serial console and the monitor (see
+Use :kbd:`Ctrl+a c` to switch between the serial console and the monitor (see
 :ref:`GUI_keys`).