doc: twister: inline twister --help output into the docs

In order to make it easier for folks to discover available twister
options when using/searching the documentation, or when making external
search in their favorite search engine, inline the output of
`twister --help` into the docs so as to have an always up-to-date
and searchable snapshot of it.

Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
This commit is contained in:
Benjamin Cabé 2025-07-08 17:56:42 +02:00 committed by Daniel DeGrasse
parent 70b910981d
commit cae12e6d6a
4 changed files with 10 additions and 3 deletions

View File

@ -76,6 +76,7 @@ extensions = [
"sphinx.ext.autodoc", "sphinx.ext.autodoc",
"sphinx.ext.graphviz", "sphinx.ext.graphviz",
"sphinxcontrib.jquery", "sphinxcontrib.jquery",
"sphinxcontrib.programoutput",
"zephyr.application", "zephyr.application",
"zephyr.html_redirects", "zephyr.html_redirects",
"zephyr.kconfig", "zephyr.kconfig",

View File

@ -83,9 +83,8 @@ The list of command line options supported by twister can be viewed using:
.. group-tab:: Linux .. group-tab:: Linux
.. code-block:: bash .. command-output:: $ZEPHYR_BASE/scripts/twister --help
:shell:
$ ./scripts/twister --help
.. group-tab:: Windows .. group-tab:: Windows

View File

@ -10,6 +10,7 @@ sphinx-copybutton
sphinx-togglebutton sphinx-togglebutton
sphinx-sitemap sphinx-sitemap
sphinx-autobuild sphinx-autobuild
sphinxcontrib.programoutput
# YAML validation. Used by zephyr_module. # YAML validation. Used by zephyr_module.
PyYAML>=6.0 PyYAML>=6.0

View File

@ -508,6 +508,7 @@ sphinx==8.1.3 ; python_full_version < '3.11' \
# sphinx-tabs # sphinx-tabs
# sphinx-togglebutton # sphinx-togglebutton
# sphinxcontrib-jquery # sphinxcontrib-jquery
# sphinxcontrib-programoutput
# sphinxcontrib-svg2pdfconverter # sphinxcontrib-svg2pdfconverter
sphinx==8.2.3 ; python_full_version >= '3.11' \ sphinx==8.2.3 ; python_full_version >= '3.11' \
--hash=sha256:398ad29dee7f63a75888314e9424d40f52ce5a6a87ae88e7071e80af296ec348 \ --hash=sha256:398ad29dee7f63a75888314e9424d40f52ce5a6a87ae88e7071e80af296ec348 \
@ -522,6 +523,7 @@ sphinx==8.2.3 ; python_full_version >= '3.11' \
# sphinx-tabs # sphinx-tabs
# sphinx-togglebutton # sphinx-togglebutton
# sphinxcontrib-jquery # sphinxcontrib-jquery
# sphinxcontrib-programoutput
# sphinxcontrib-svg2pdfconverter # sphinxcontrib-svg2pdfconverter
sphinx-autobuild==2024.10.3 \ sphinx-autobuild==2024.10.3 \
--hash=sha256:158e16c36f9d633e613c9aaf81c19b0fc458ca78b112533b20dafcda430d60fa \ --hash=sha256:158e16c36f9d633e613c9aaf81c19b0fc458ca78b112533b20dafcda430d60fa \
@ -575,6 +577,10 @@ sphinxcontrib-jsmath==1.0.1 \
--hash=sha256:2ec2eaebfb78f3f2078e73666b1415417a116cc848b72e5172e596c871103178 \ --hash=sha256:2ec2eaebfb78f3f2078e73666b1415417a116cc848b72e5172e596c871103178 \
--hash=sha256:a9925e4a4587247ed2191a22df5f6970656cb8ca2bd6284309578f2153e0c4b8 --hash=sha256:a9925e4a4587247ed2191a22df5f6970656cb8ca2bd6284309578f2153e0c4b8
# via sphinx # via sphinx
sphinxcontrib-programoutput==0.18 \
--hash=sha256:09e68b6411d937a80b6085f4fdeaa42e0dc5555480385938465f410589d2eed8 \
--hash=sha256:8a651bc85de69a808a064ff0e48d06c12b9347da4fe5fdb1e94914b01e1b0c36
# via -r requirements.in
sphinxcontrib-qthelp==2.0.0 \ sphinxcontrib-qthelp==2.0.0 \
--hash=sha256:4fe7d0ac8fc171045be623aba3e2a8f613f8682731f9153bb2e40ece16b9bbab \ --hash=sha256:4fe7d0ac8fc171045be623aba3e2a8f613f8682731f9153bb2e40ece16b9bbab \
--hash=sha256:b18a828cdba941ccd6ee8445dbe72ffa3ef8cbe7505d8cd1fa0d42d3f2d5f3eb --hash=sha256:b18a828cdba941ccd6ee8445dbe72ffa3ef8cbe7505d8cd1fa0d42d3f2d5f3eb