| /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/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/ |
| D | index.rst | 7 improving documentation, or proposing new features, your efforts are highly appreciated. This page
57 Documentation section in Contributing to Zephyr
60 The Zephyr project thrives on good documentation. Whether it is as part of a code contribution or
61 as a standalone effort, contributing documentation is particularly valuable to the project.
67 documentation/guidelines.rst
68 documentation/generation.rst
71 This page provides some simple guidelines for writing documentation using the reSTructuredText
72 (reST) markup language and Sphinx documentation generator.
75 As you write documentation, it can be helpful to see how it will look when rendered.
77 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/boards/google/quincy/doc/ |
| D | index.rst | 31 follow the `Chromium EC Flashing Documentation`_ and
32 `Chromium Servo Micro Documentation`_.
44 .. _Chromium EC Flashing Documentation:
46 .. _Chromium Servo Micro Documentation:
|
| /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
|
| /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.
45 [ 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/doc/develop/languages/rust/ |
| D | index.rst | 78 API Documentation
81 The `API Documentation`_ for the latest version in the module is kept on gh-pages.
83 .. _`API Documentation`: argument
86 This documentation is generated for a general target, with all features enabled. Once you have an
87 application that is buildable, you can generate documentation specifically for your target:
|
| /Zephyr-latest/boards/pimoroni/pico_plus2/ |
| D | board.cmake | 7 # The Raspberry Pi's OpenOCD fork doesn't, so match their documentation at
8 # https://www.raspberrypi.com/documentation/microcontrollers/debug-probe.html#debugging-with-swd
|
| /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
|
| /Zephyr-latest/boards/shields/eval_ad4052_ardz/doc/ |
| D | index.rst | 43 … https://www.analog.com/media/en/technical-documentation/user-guides/eval-ad4050-ad4052-ug-2222.pdf
46 …https://www.analog.com/media/en/evaluation-documentation/evaluation-design-files/eval-ad4052-ardz-…
52 https://www.analog.com/media/en/technical-documentation/data-sheets/ad4052-ad4058.pdf
|
| /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/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/boards/wiznet/w5500_evb_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/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/.github/workflows/ |
| D | doc-publish.yml | 5 name: Documentation Publish
9 workflows: ["Documentation Build"]
18 name: Publish Documentation
|
| /Zephyr-latest/boards/atmel/sam/sam4l_ek/doc/ |
| D | index.rst | 57 The `SAM4L-EK Design Documentation`_ has detailed information about board
58 connections. Download the `SAM4L-EK Design Documentation`_ for more details.
85 "J-Link Software and Documentation Pack" and install the "J-Link Software
86 and Documentation pack for Linux". The application JLinkExe needs to be
134 .. _SAM4L-EK Design Documentation:
|
