Searched full:documentation (Results 1 – 25 of 553) sorted by relevance
12345678910>>...23
| /Zephyr-Core-3.4.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.4.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
8 For instructions on building the documentation, see :ref:`zephyr_doc`.
14 Sphinx installed) they can build the documentation using the Makefile
18 `Zephyr documentation`_ website (with a different theme applied).
26 .. _Zephyr documentation: https://docs.zephyrproject.org
29 Sphinx-defined directives and roles used to create the documentation
255 documentation for the full list).
265 using ``:zephyr_file:`doc/contribute/documentation/index.rst``` that will
266 show up as :zephyr_file:`doc/contribute/documentation/index.rst`, a link to
268 ``:zephyr_raw:`doc/guides/documentation/index.rst``` role that will
[all …]
|
| D | index.rst | 3 Documentation chapter
|
| /Zephyr-Core-3.4.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.4.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.4.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
12 # Documentation targets
|
| /Zephyr-Core-3.4.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.4.0/cmake/modules/ |
| D | doc.cmake | 6 # documentation build.
16 # The Zephyr package required for documentation build setup.
|
| /Zephyr-Core-3.4.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
|
| D | doc-build.yml | 4 name: Documentation Build
37 name: "Documentation Build (HTML)"
107 echo "Documentation will be available shortly at: ${DOC_URL}" >> $GITHUB_STEP_SUMMARY
117 name: "Documentation Build (PDF)"
|
| /Zephyr-Core-3.4.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.4.0/ |
| D | CONTRIBUTING.rst | 11 documentation.
34 Coding Style, sanity checks builds, and documentation builds.
|
| D | README.rst | 40 and the documentation's `Getting Started Guide`_ to start developing.
58 * **Documentation**: http://docs.zephyrproject.org (`Getting Started Guide`_)
77 security issues; also see our `Security`_ documentation. Security issues are
83 .. _Zephyr Documentation: http://docs.zephyrproject.org
|
| /Zephyr-Core-3.4.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.4.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.4.0/boards/arm/google_dragonclaw/doc/ |
| D | index.rst | 34 follow the `Chromium EC Flashing Documentation`_.
49 .. _Chromium EC Flashing Documentation:
|
| /Zephyr-Core-3.4.0/boards/arm/cc3235sf_launchxl/ |
| D | board.cmake | 3 # See the Zephyr project CC3235SF_LAUNCHXL documentation on
|
| /Zephyr-Core-3.4.0/doc/kernel/util/ |
| D | index.rst | 6 This page contains reference documentation for ``<sys/util.h>``, which provides
|
| /Zephyr-Core-3.4.0/boards/shields/mikroe_wifi_bt_click/ |
| D | mikroe_wifi_bt_click.overlay | 7 * This file is intentionally empty. Please confer with shield documentation
|
| /Zephyr-Core-3.4.0/boards/shields/inventek_eswifi/ |
| D | inventek_eswifi.overlay | 8 * This file is intentionally empty. Please refer to shield documentation for
|
12345678910>>...23
