| /Zephyr-Core-3.5.0/doc/project/ |
| D | documentation.rst | 1 .. _code-documentation:
3 Code Documentation
6 API Documentation
11 documentation tool that the zephyr project uses for documenting APIs. It
12 generates either an on-line documentation browser (in HTML) and/or provides
15 when producing the Zephyr project's online documentation.
21 features and can be traced back to features. We use the API documentation as the
26 Test Documentation
31 documentation for all unit and integration tests maintained in the same
37 Documentation Guidelines
[all …]
|
| /Zephyr-Core-3.5.0/doc/contribute/documentation/ |
| D | generation.rst | 3 Documentation Generation
7 documentation on your local system using the same documentation sources
8 as we use to create the online documentation found at
13 Documentation overview
22 Project's public website documentation area (with a different theme
28 The project's documentation contains the following items:
30 * ReStructuredText source files used to generate documentation found at the
43 :caption: Schematic of the documentation build process
67 The reStructuredText files are processed by the Sphinx documentation system,
70 documentation locally, as described in the following sections.
[all …]
|
| D | guidelines.rst | 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
256 documentation for the full list).
266 using ``:zephyr_file:`doc/contribute/documentation/index.rst``` that will
267 show up as :zephyr_file:`doc/contribute/documentation/index.rst`, a link to
[all …]
|
| /Zephyr-Core-3.5.0/doc/contribute/ |
| D | index.rst | 7 improving documentation, or proposing new features, your efforts are highly appreciated. This page
44 Documentation section in Contributing to Zephyr
47 The Zephyr project thrives on good documentation. Whether it is as part of a code contribution or
48 as a standalone effort, contributing documentation is particularly valuable to the project.
54 documentation/guidelines.rst
55 documentation/generation.rst
58 This page provides some simple guidelines for writing documentation using the reSTructuredText
59 (reST) markup language and Sphinx documentation generator.
62 As you write documentation, it can be helpful to see how it will look when rendered.
64 This page describes how to build the Zephyr documentation locally.
|
| /Zephyr-Core-3.5.0/doc/hardware/arch/ |
| D | semihost.rst | 13 More complete documentation on the available functionality is available at the
14 `ARM Github documentation`_.
17 `RISC-V Github documentation`_.
59 in :c:enum:`semihost_instr`. For complete documentation on the required
60 arguments and return codes, see the `ARM Github documentation`_.
67 .. _ARM Github documentation: https://github.com/ARM-software/abi-aa/blob/main/semihosting/semihost…
68 .. _RISC-V Github documentation: https://github.com/riscv/riscv-semihosting-spec/blob/main/riscv-se…
|
| /Zephyr-Core-3.5.0/doc/_extensions/zephyr/ |
| D | dtcompatible-role.py | 12 documentation for a devicetree
16 generated documentation page for the devicetree binding handling
25 The Zephyr documentation uses the standard :option: role to refer
34 Do not use it directly. The generated bindings documentation puts these
|
| /Zephyr-Core-3.5.0/dts/ |
| D | binding-template.yaml | 1 # The contents of this file have been moved to the documentation.
3 # See this page in the HTML documentation:
|
| /Zephyr-Core-3.5.0/doc/ |
| D | index.rst | 2 Zephyr Project documentation main file
6 Zephyr Project Documentation
11 Welcome to the Zephyr Project's documentation for version |version|.
13 Documentation for the latest (main) development branch of Zephyr
18 **Welcome to the Zephyr Project's documentation
22 documentation for a specific version of Zephyr.
25 consult the published :ref:`zephyr_release_notes` documentation.
|
| D | index-tex.rst | 4 Zephyr Project documentation main file
8 Zephyr Project Documentation
|
| D | zephyr.doxyfile.in | 3 # This file describes the settings to be used by the documentation system
41 # project for which the documentation is generated. This name is used in the
45 PROJECT_NAME = "Zephyr API Documentation"
48 # could be handy for archiving the generated documentation or if some version
60 # in the documentation. The maximum height of the logo should not exceed 55
67 # into which the generated documentation will be written. If a relative path is
104 # documentation generated by doxygen is written. Doxygen will use this
120 # documentation (similar to Javadoc). Set to NO to disable this.
153 # inherited members of a class in the documentation of that class as if those
180 # path mentioned in the documentation of a class, which tells the reader which
[all …]
|
| D | Makefile | 2 # Makefile for documentation build
13 # Documentation targets
|
| /Zephyr-Core-3.5.0/cmake/modules/ |
| D | doc.cmake | 6 # documentation build.
16 # The Zephyr package required for documentation build setup.
|
| /Zephyr-Core-3.5.0/.github/workflows/ |
| D | doc-publish.yml | 5 name: Documentation Publish
9 workflows: ["Documentation Build"]
18 name: Publish Documentation
|
| D | doc-publish-pr.yml | 5 name: Documentation Publish (Pull Request)
9 workflows: ["Documentation Build"]
15 name: Publish Documentation
|
| /Zephyr-Core-3.5.0/dts/bindings/iio/afe/ |
| D | current-sense-shunt.yaml | 10 This is based on Linux, documentation:
11 https://www.kernel.org/doc/Documentation/devicetree/bindings/iio/afe/current-sense-shunt.yaml
|
| D | current-sense-amplifier.yaml | 10 This is based on Linux, documentation:
11 … https://www.kernel.org/doc/Documentation/devicetree/bindings/iio/afe/current-sense-amplifier.yaml
|
| /Zephyr-Core-3.5.0/tests/net/all/ |
| D | check_net_options.sh | 11 echo "documentation is generated."
29 echo "Kconfig documentation not found at $kconfig_dir"
|
| /Zephyr-Core-3.5.0/ |
| D | README.rst | 40 and the documentation's `Getting Started Guide`_ to start developing.
60 | �� `Zephyr Documentation`_
85 | �� `Security documentation`_
97 .. _Zephyr Documentation: https://docs.zephyrproject.org
109 .. _Security documentation: https://docs.zephyrproject.org/latest/security/index.html
|
| D | CONTRIBUTING.rst | 11 documentation.
34 Coding Style, sanity checks builds, and documentation builds.
|
| /Zephyr-Core-3.5.0/doc/develop/api/ |
| D | api_lifecycle.rst | 32 - Documentation of the API (usage)
42 When introducing an API (public header file with documentation) for a new
81 - Complete documentation in code. All public interfaces shall be documented
82 and available in online documentation.
159 - Changes to the relevant API documentation
222 - API documentation will inform users that the API is deprecated.
238 the corresponding documentation, and communicate the removal in the usual ways:
|
| /Zephyr-Core-3.5.0/boards/arm/google_dragonclaw/doc/ |
| D | index.rst | 34 follow the `Chromium EC Flashing Documentation`_.
49 .. _Chromium EC Flashing Documentation:
|
| /Zephyr-Core-3.5.0/dts/bindings/espi/ |
| D | microchip,xec-espi-host-dev.yaml | 33 Logical device Host I/O (x86) base. Refer to SoC documentation for the
48 documentation for which logical devices implement a memory decoder
|
| /Zephyr-Core-3.5.0/boards/arm/cc3235sf_launchxl/ |
| D | board.cmake | 3 # See the Zephyr project CC3235SF_LAUNCHXL documentation on
|
| /Zephyr-Core-3.5.0/doc/kernel/util/ |
| D | index.rst | 6 This page contains reference documentation for ``<sys/util.h>``, which provides
|
| /Zephyr-Core-3.5.0/subsys/bindesc/ |
| D | Kconfig.build_time | 82 function, so refer to string's documentation for more info on the different formats.
97 function, so refer to string's documentation for more info on the different formats.
110 function, so refer to string's documentation for more info on the different formats.
|
