Lines Matching +full:label +full:- +full:prefix
24 .. _Sphinx extensions: http://www.sphinx-doc.org/en/stable/contents.html
26 .. _Sphinx Inline Markup: http://sphinx-doc.org/markup/inline.html#inline-markup
30 Sphinx-defined directives and roles used to create the documentation
42 the first non-white space in the preceding line. For example::
50 .. code-block::
66 * Third section heading level (h4) use ``-``
84 For bullet lists, place an asterisk (``*``) or hyphen (``-``) at
113 #. This is a second-level list under the first item (also
143 Multi-column lists
148 a special ``.. rst-class:: rst-columns`` directive. The directive will
149 apply to the next non-comment element (e.g., paragraph), or to content
152 .. rst-class:: rst-columns
166 .. rst-class:: rst-columns
188 <http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html#grid-tables>`_
192 +------------------------+------------+----------+----------+
197 +------------------------+------------+----------+----------+
199 +------------------------+------------+----------+ easily +
201 +------------------------+------------+----------+ rows +
203 +------------------------+------------+----------+----------+
207 +------------------------+------------+----------+----------+
212 +------------------------+------------+----------+----------+
214 +------------------------+------------+----------+ easily +
216 +------------------------+------------+----------+ rows +
218 +------------------------+------------+----------+----------+
221 <http://docutils.sourceforge.net/docs/ref/rst/directives.html#list-table>`_
224 .. list-table:: Table title
226 :header-rows: 1
228 * - Heading 1
229 - Heading 2
230 - Heading 3
231 * - body row 1, column 1
232 - body row 1, column 2
233 - body row 1, column 3
234 * - body row 2, column 1
235 - body row 2, column 2
236 - body row 2, column 3
240 .. list-table:: Table title
242 :header-rows: 1
244 * - Heading 1
245 - Heading 2
246 - Heading 3
247 * - body row 1, column 1
248 - body row 1, column 2
249 - body row 1, column 3
250 * - body row 2, column 1
251 - body row 2, column 2
252 - body row 2, column 3
255 default is equal column widths. If you have a three-column table and you
256 want the first column to be half as wide as the other two equal-width
303 .. group-tab:: Linux
307 .. group-tab:: macOS
311 .. group-tab:: Windows
317 .. group-tab:: Linux
321 .. group-tab:: macOS
325 .. group-tab:: Windows
329 In this latter case, we're using ``.. group-tab::`` instead of simply
330 ``.. tab::``. Under the hood, we're using the `sphinx-tabs
331 <https://github.com/executablebooks/sphinx-tabs>`_ extension that's included
333 than a heading* (code-blocks, ordered and unordered lists, pictures,
334 paragraphs, and such). You can read more about sphinx-tabs from the
348 .. _additional roles provided by Sphinx: https://www.sphinx-doc.org/en/master/usage/restructuredtex…
397 * :rst:role:`kbd` for keyboard input, e.g., ``:kbd:`Ctrl-C``` will render as :kbd:`Ctrl-C`
399 * :rst:role:`menuselection` for menu selections, e.g., ``:menuselection:`File --> Open``` will rend…
400 as :menuselection:`File --> Open`
418 Non-ASCII Characters
421 You can insert non-ASCII characters such as a Trademark symbol (|trade|),
437 Use the reST :rst:dir:`code-block` directive to create a highlighted block of
438 fixed-width text, typically used for showing formatted code or console
443 .. code-block:: c
453 Note the blank line between the :rst:dir:`code-block` directive and the first
454 line of the code-block body, and the body content is indented three
455 spaces (to the first non-white space of the directive name).
459 .. code-block:: c
484 ``bash`` for conveying that the commands are bash-specific, and ``shell`` for generic shell
494 .. list-table:: When to use ``bash``/``shell`` vs. ``console``
495 :class: wrap-normal
496 :header-rows: 1
499 * - Use case
500 - ``code-block`` snippet
501 - Expected output
503 * - One or several commands, no output
505 - .. code-block:: rst
507 .. code-block:: shell
511 - .. code-block:: shell
515 * - An interactive shell session with command(s) and their output
517 - .. code-block:: rst
519 .. code-block:: console
524 - .. code-block:: console
529 * - An interactive Zephyr shell session, with commands and their outputs
531 - .. code-block:: rst
533 .. code-block:: console
540 - .. code-block:: console
558 .. code-block:: none
565 .. code-block:: none
577 Links and Cross-References
580 .. _internal-linking:
582 Cross-referencing internal content
588 Refer to the `internal-linking`_ page
592 Refer to the `internal-linking`_ page
595 underscore to indicate an outbound link. In this example, the label was
600 Refer to the `show this text instead <internal-linking_>`_ page
604 Refer to the `show this text instead <internal-linking_>`_ page
607 Cross-referencing external content
611 link-references to any tagged text within the Zephyr Project documentation.
613 Target locations in a document are defined with a label directive::
615 .. _my label name:
622 this label must be a heading, and is the target for a ``:ref:`my label name```
624 The heading text is shown when referencing this label.
627 :ref:`some other text <my label name>`
630 To enable easy cross-page linking within the site, each file should have
631 a reference label before its title so it can
648 For example, with this label definition in the document::
662 :rst:dir:`target-notes` directive. Example::
667 .. target-notes::
672 Cross-referencing C documentation
686 You may use these roles to cross-reference the Doxygen documentation of C functions, macros,
698 You may provide a custom link text, similar to the built-in :rst:role:`ref` role.
710 .. image:: ../../images/doc-gen-flow.png
716 .. figure:: ../../images/doc-gen-flow.png
733 ------------------------------------------
757 A -> B;
758 B -> C;
759 C -> D;
768 A -> B;
769 B -> C;
770 C -> D;
789 .. rst:directive:: .. zephyr-app-commands::
796 .. zephyr-app-commands::
797 :zephyr-app: samples/hello_world
803 .. zephyr-app-commands::
804 :zephyr-app: samples/hello_world
821 .. rst:directive:option:: zephyr-app
827 .. rst:directive:option:: cd-into
841 .. rst:directive:option:: host-os
863 If multiple configuration files are provided, enclose the space-separated list of files with
866 .. rst:directive:option:: gen-args
871 .. rst:directive:option:: build-args
876 .. rst:directive:option:: west-args
881 .. rst:directive:option:: flash-args
893 .. rst:directive:option:: build-dir
896 If set, the application build directory will *APPEND* this relative, Unix-separated, path to
900 .. rst:directive:option:: build-dir-fmt
903 If set, assume that `west config build.dir-fmt`` has been set to this path.
905 Exclusive with ``:build-dir:`` and depends on ``:tool: west``.
910 A whitespace-separated list of what to do with the app (any of ``build``, ``flash``,
915 .. rst:directive:option:: maybe-skip-config
929 Cross-referencing files in the Zephyr tree
946 :samp:`#L{start_line}-L{end_line}` to the file path::
988 Cross-referencing GitHub issues and pull requests
1012 corresponding Doxygen-generated documentation.
1014 All the code samples (declared using the :rst:dir:`zephyr:code-sample` directive) indicating the
1037 they are rendered as links to the corresponding Doxygen-generated documentation for the group.
1046 You may provide a custom link text, similar to the built-in :rst:role:`ref` role.
1057 Make sure to use the full name of the Kconfig option, including the ``CONFIG_`` prefix.
1087 Check out :dtcompatible:`zephyr,input-longpress` for more information.
1091 Check out :dtcompatible:`zephyr,input-longpress` for more information.
1096 .. rst:directive:: .. zephyr:code-sample:: id
1103 .. zephyr:code-sample:: blinky
1105 :relevant-api: gpio_interface
1116 Indicates the human-readable short name of the sample.
1118 .. rst:directive:option:: relevant-api
1121 Optional space-separated list of Doxygen group names that correspond to the APIs exercised
1124 .. rst:role:: zephyr:code-sample
1126 This role is used to reference a code sample described using :rst:dir:`zephyr:code-sample`.
1130 Check out :zephyr:code-sample:`blinky` for more information.
1134 Check out :zephyr:code-sample:`blinky` for more information.
1136 This can be used exactly like the built-in :rst:role:`ref` role, i.e. you may provide a custom
1139 Check out :zephyr:code-sample:`blinky code sample <blinky>` for more information.
1143 Check out :zephyr:code-sample:`blinky code sample <blinky>` for more information.
1145 .. rst:directive:: .. zephyr:code-sample-category:: id
1151 .. zephyr:code-sample-category:: gpio
1153 :show-listing:
1165 Indicates the human-readable name of the category.
1167 .. rst:directive:option:: show-listing
1180 .. rst:role:: zephyr:code-sample-category
1183 :rst:dir:`zephyr:code-sample-category`.
1187 Check out :zephyr:code-sample-category:`cloud` samples for more information.
1191 Check out :zephyr:code-sample-category:`cloud` samples for more information.
1193 .. rst:directive:: .. zephyr:code-sample-listing::
1199 .. zephyr:code-sample-listing::
1204 .. zephyr:code-sample-listing::
1212 A space-separated list of category IDs for which to show the listing.
1214 .. rst:directive:option:: live-search
1249 .. rst:directive:: .. zephyr:board-catalog::
1251 This directive is used to generate a catalog of Zephyr-supported boards that can be used to
1254 .. rst:directive:: .. zephyr:board-supported-hw::
1272 .. target-notes::