Lines Matching +full:white +full:- +full:output +full:- +full:current
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
126 Build the HTML output for the project
129 Remove all generated output, restoring the folders to a
137 Build the HTML output for the project
140 Remove all generated output, restoring the folders to a
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
298 Tabs can also be grouped, so that changing the current tab in one area
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…
368 meanings and allow style output formatting. (You can refer to the `Sphinx Inline Markup`_
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
439 commands and output. Smart syntax highlighting is also supported (using the
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
478 * ``console`` for console output, i.e. interactive shell sessions where commands are prefixed by a
479 prompt (ex. ``$`` for Linux, or ``uart:~$`` for Zephyr's shell), and where the output is also
480 shown. The commands will be highlighted, and the output will not. What's more, copying code block
484 ``bash`` for conveying that the commands are bash-specific, and ``shell`` for generic shell
492 showcasing an interactive session with command(s) and their output.
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
571 (``::``) and indent the code block content that follows it by three spaces. On output, only one
577 Links and Cross-References
580 .. _internal-linking:
582 Cross-referencing internal content
585 Traditional ReST links are only supported within the current file using the
588 Refer to the `internal-linking`_ page
592 Refer to the `internal-linking`_ page
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.
630 To enable easy cross-page linking within the site, each file should have
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,
689 They are rendered in the HTML output as links to the corresponding Doxygen documentation for the
698 You may provide a custom link text, similar to the built-in :rst:role:`ref` role.
708 .. image:: ../../images/doc-gen-flow.png
714 .. figure:: ../../images/doc-gen-flow.png
731 ------------------------------------------
755 A -> B;
756 B -> C;
757 C -> D;
766 A -> B;
767 B -> C;
768 C -> D;
787 .. rst:directive:: .. zephyr-app-commands::
794 .. zephyr-app-commands::
795 :zephyr-app: samples/hello_world
801 .. zephyr-app-commands::
802 :zephyr-app: samples/hello_world
819 .. rst:directive:option:: zephyr-app
825 .. rst:directive:option:: cd-into
839 .. rst:directive:option:: host-os
861 If multiple configuration files are provided, enclose the space-separated list of files with
864 .. rst:directive:option:: gen-args
869 .. rst:directive:option:: build-args
874 .. rst:directive:option:: west-args
879 .. rst:directive:option:: flash-args
891 .. rst:directive:option:: build-dir
894 If set, the application build directory will *APPEND* this relative, Unix-separated, path to
898 .. rst:directive:option:: build-dir-fmt
901 If set, assume that `west config build.dir-fmt`` has been set to this path.
903 Exclusive with ``:build-dir:`` and depends on ``:tool: west``.
908 A whitespace-separated list of what to do with the app (any of ``build``, ``flash``,
913 .. rst:directive:option:: maybe-skip-config
922 If set, the generated output is a single code block with no additional comment lines.
927 Cross-referencing files in the Zephyr tree
972 Cross-referencing GitHub issues and pull requests
995 This directive is used to output a short description of a Doxygen group and a link to the
996 corresponding Doxygen-generated documentation.
998 All the code samples (declared using the :rst:dir:`zephyr:code-sample` directive) indicating the
999 group as relevant will automatically be list and referenced in the rendered output.
1012 they are rendered as links to the corresponding Doxygen-generated documentation for the group.
1021 You may provide a custom link text, similar to the built-in :rst:role:`ref` role.
1030 output.
1050 building HTML output.
1062 Check out :dtcompatible:`zephyr,input-longpress` for more information.
1066 Check out :dtcompatible:`zephyr,input-longpress` for more information.
1071 .. rst:directive:: .. zephyr:code-sample:: id
1078 .. zephyr:code-sample:: blinky
1080 :relevant-api: gpio_interface
1091 Indicates the human-readable short name of the sample.
1093 .. rst:directive:option:: relevant-api
1096 Optional space-separated list of Doxygen group names that correspond to the APIs exercised
1099 .. rst:role:: zephyr:code-sample
1101 This role is used to reference a code sample described using :rst:dir:`zephyr:code-sample`.
1105 Check out :zephyr:code-sample:`blinky` for more information.
1109 Check out :zephyr:code-sample:`blinky` for more information.
1111 This can be used exactly like the built-in :rst:role:`ref` role, i.e. you may provide a custom
1114 Check out :zephyr:code-sample:`blinky code sample <blinky>` for more information.
1118 Check out :zephyr:code-sample:`blinky code sample <blinky>` for more information.
1120 .. rst:directive:: .. zephyr:code-sample-category:: id
1126 .. zephyr:code-sample-category:: gpio
1128 :show-listing:
1140 Indicates the human-readable name of the category.
1142 .. rst:directive:option:: show-listing
1146 generated based on all code samples found in the subdirectories of the current document.
1155 .. rst:role:: zephyr:code-sample-category
1158 :rst:dir:`zephyr:code-sample-category`.
1162 Check out :zephyr:code-sample-category:`cloud` samples for more information.
1166 Check out :zephyr:code-sample-category:`cloud` samples for more information.
1168 .. rst:directive:: .. zephyr:code-sample-listing::
1174 .. zephyr:code-sample-listing::
1179 .. zephyr:code-sample-listing::
1187 A space-separated list of category IDs for which to show the listing.
1189 .. rst:directive:option:: live-search
1224 .. rst:directive:: .. zephyr:board-catalog::
1226 This directive is used to generate a catalog of Zephyr-supported boards that can be used to
1233 .. target-notes::