summary refs log tree commit diff stats
path: root/docs/devel/testing
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/devel/testing
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/devel/testing')
-rw-r--r--docs/devel/testing/main.rst4
1 files changed, 2 insertions, 2 deletions
diff --git a/docs/devel/testing/main.rst b/docs/devel/testing/main.rst
index 6b18ed875c..2b5cb0c148 100644
--- a/docs/devel/testing/main.rst
+++ b/docs/devel/testing/main.rst
@@ -604,9 +604,9 @@ below steps to debug it:
 2. Add "V=1" to the command line, try again, to see the verbose output.
 3. Further add "DEBUG=1" to the command line. This will pause in a shell prompt
    in the container right before testing starts. You could either manually
-   build QEMU and run tests from there, or press Ctrl-D to let the Docker
+   build QEMU and run tests from there, or press :kbd:`Ctrl+d` to let the Docker
    testing continue.
-4. If you press Ctrl-D, the same building and testing procedure will begin, and
+4. If you press :kbd:`Ctrl+d`, the same building and testing procedure will begin, and
    will hopefully run into the error again. After that, you will be dropped to
    the prompt for debug.