| /Zephyr-latest/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-latest/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
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.
[all …]
|
| /Zephyr-latest/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-latest/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-latest/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.
87 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
73 # into which the generated documentation will be written. If a relative path is
110 # documentation generated by Doxygen is written. Doxygen will use this
126 # documentation (similar to Javadoc). Set to NO to disable this.
159 # inherited members of a class in the documentation of that class as if those
186 # path mentioned in the documentation of a class, which tells the reader which
[all …]
|
| /Zephyr-latest/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-latest/doc/templates/ |
| D | board.tmpl | 3 .. To ensure the board documentation page displays correctly, it is highly
4 recommended to include a picture alongside the documentation page.
44 [ Links to external references such as datasheets or additional documentation]
|
| /Zephyr-latest/cmake/modules/ |
| D | doc.cmake | 6 # documentation build.
16 # The Zephyr package required for documentation build setup.
|
| /Zephyr-latest/dts/bindings/spi/ |
| D | microchip,xec-qmspi-ldma.yaml | 58 If not present use hardware default value. Refer to chip documentation
65 If not present use hardware default value. Refer to chip documentation
73 documentation for QMSPI input clock frequency.
79 If not present use hardware default value. Refer to chip documentation
|
| /Zephyr-latest/dts/bindings/sensor/ |
| D | avago,apds9253.yaml | 24 Default value is chosen from the official documentation.
47 Default value is chosen from the official documentation.
66 Default value is chosen from the official documentation.
|
| /Zephyr-latest/dts/bindings/gpio/ |
| D | adi,max14906-gpio.yaml | 57 Default values are from documentation.
66 Default values are from documentation.
76 Default values are from documentation.
86 Default values are from documentation.
110 Default values are from documentation.
160 Default values are from documentation.
175 Default values are from documentation.
190 Default values are from documentation.
|
| D | adi,max14916-gpio.yaml | 57 Default values are from documentation.
66 Default values are from documentation.
75 Default values are from documentation.
99 Default values are from documentation.
149 Default values are from documentation.
164 Default values are from documentation.
179 Default values are from documentation.
|
| /Zephyr-latest/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-latest/doc/develop/sca/ |
| D | cpptest.rst | 10 Documentation of C/C++test can be found at https://docs.parasoft.com/. Please refer to the
11 documentation for how to use it.
30 Please refer to Parasoft C/C++test documentation for more details.
|
| /Zephyr-latest/doc/develop/tools/ |
| D | vscode.rst | 74 guide does not cover them yet, you may refer to their documentation to set them up:
82 Documentation languages extensions
90 - `CMake Extension documentation`_
106 .. _VS Code documentation: https://code.visualstudio.com/docs
108 .. _C/C++ Extension documentation: https://code.visualstudio.com/docs/languages/cpp
109 .. _CMake Extension documentation: https://code.visualstudio.com/docs/cpp/cmake-linux
|
| /Zephyr-latest/boards/raspberrypi/rpi_pico2/ |
| D | board.cmake | 11 # The Raspberry Pi's OpenOCD fork doesn't, so match their documentation at
12 # https://www.raspberrypi.com/documentation/microcontrollers/debug-probe.html#debugging-with-swd
|
| /Zephyr-latest/.github/workflows/ |
| D | doc-publish.yml | 5 name: Documentation Publish
9 workflows: ["Documentation Build"]
18 name: Publish Documentation
|
| D | doc-build.yml | 4 name: Documentation Build
39 - name: Check if Documentation related files changed
61 name: "Documentation Build (HTML)"
140 # API documentation coverage
174 echo "Documentation will be available shortly at: ${DOC_URL}" >> $GITHUB_STEP_SUMMARY
175 … echo "API Documentation will be available shortly at: ${API_DOC_URL}" >> $GITHUB_STEP_SUMMARY
186 name: "Documentation Build (PDF)"
260 name: "Documentation Build Status"
|
| D | doc-publish-pr.yml | 5 name: Documentation Publish (Pull Request)
9 workflows: ["Documentation Build"]
15 name: Publish Documentation
|
| /Zephyr-latest/tests/net/all/ |
| D | check_net_options.sh | 11 echo "documentation is generated."
29 echo "Kconfig documentation not found at $kconfig_dir"
|
| /Zephyr-latest/ |
| D | README.rst | 37 and the documentation's `Getting Started Guide`_ to start developing.
57 | �� `Zephyr Documentation`_
82 | �� `Security documentation`_
94 .. _Zephyr Documentation: https://docs.zephyrproject.org
106 .. _Security documentation: https://docs.zephyrproject.org/latest/security/index.html
|
