Lines Matching full:documentation

3 Documentation Guidelines
10    For instructions on building the documentation, see :ref:`zephyr_doc`.
16 Sphinx installed) they can :ref:`build the documentation <zephyr_doc>` locally
17 to generate the documentation in HTML or PDF format. The HTML content can
19 `Zephyr documentation`_ website.
27 .. _Zephyr documentation:  https://docs.zephyrproject.org
30 Sphinx-defined directives and roles used to create the documentation
342 reference for some of the most commonly used text formatting options in Zephyr documentation. For an
369 documentation for the full list).
611 link-references to any tagged text within the Zephyr Project documentation.
623 reference from anywhere within the Zephyr documentation.
638    Documentation Guidelines for the Zephyr Project
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
708 Images are included in the documentation by using an :rst:dir:`image` directive::
747 to allow for diagrams used in the documentation to be easily maintained, we encourage the use of
773 Please refer to the `Graphviz documentation`_ for more information on how to create diagrams using
777 .. _Graphviz documentation: https://graphviz.org/documentation
783 The Zephyr documentation uses custom Sphinx roles and directives to provide additional functionality
784 and to make it easier to write and maintain consistent documentation.
791    Generate consistent documentation of the shell commands needed to manage (build, flash, etc.) an
939       Check out :zephyr_file:`doc/contribute/documentation/guidelines.rst` for more information.
943       Check out :zephyr_file:`doc/contribute/documentation/guidelines.rst` for more information.
948       See :zephyr_file:`doc/contribute/documentation/guidelines.rst#L3` for the main heading of
953       See :zephyr_file:`doc/contribute/documentation/guidelines.rst#L3` for the main heading of
957    generate a warning during documentation build if the file is not found.
970       Check out :zephyr_raw:`doc/contribute/documentation/guidelines.rst` for more information.
974       Check out :zephyr_raw:`doc/contribute/documentation/guidelines.rst` for more information.
1003 Doxygen API documentation
1012    corresponding Doxygen-generated documentation.
1036    This role is used to reference a Doxygen group in the Zephyr tree. In the HTML documentation,
1037    they are rendered as links to the corresponding Doxygen-generated documentation for the group.
1054 will automatically generate a link to the documentation of the Kconfig option when building HTML
1074 reference. The role will automatically generate a link to the documentation of the binding when
1079    This role can be used inline to make a reference to the generated documentation for the
1226    This directive is used at the beginning of a document to indicate it is the main documentation
1234    some sections of the board documentation. A board documentation page that uses this directive
1265 …  This directive requires that the documentation is built with hardware features generation enabled