| /Zephyr-Core-2.7.6/doc/development_process/ |
| 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-2.7.6/doc/guides/docs/ |
| D | index.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 …]
|
| /Zephyr-Core-2.7.6/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-2.7.6/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.
72 <p>API Documentation, Zephyr configuration, and subsystem Reference</p>
|
| 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
31 # project for which the documentation is generated. This name is used in the
38 # could be handy for archiving the generated documentation or if some version
50 # in the documentation. The maximum height of the logo should not exceed 55
57 # into which the generated documentation will be written. If a relative path is
74 # documentation generated by doxygen is written. Doxygen will use this
90 # documentation (similar to Javadoc). Set to NO to disable this.
123 # inherited members of a class in the documentation of that class as if those
150 # path mentioned in the documentation of a class, which tells the reader which
195 # documentation from any documented member that it re-implements.
[all …]
|
| D | Makefile | 2 # Makefile for documentation build
12 # Documentation targets
|
| /Zephyr-Core-2.7.6/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-2.7.6/.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
36 name: "Documentation Build (HTML)"
103 echo "::notice:: Documentation will be available shortly at: ${DOC_URL}"
113 name: "Documentation Build (PDF)"
|
| /Zephyr-Core-2.7.6/doc/contribute/documentation/ |
| D | index.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/guides/documentation/index.rst\``` that will
266 show up as :zephyr_file:`doc/guides/documentation/index.rst`, a link to
268 ``:zephyr_raw:\`doc/guides/documentation/index.rst\``` role that will
[all …]
|
| /Zephyr-Core-2.7.6/tests/net/all/ |
| D | check_net_options.sh | 11 echo "documentation is generated."
29 echo "Kconfig documentation not found at $kconfig_dir"
|
| /Zephyr-Core-2.7.6/doc/_doxygen/ |
| D | mainpage.md | 1 # API Documentation
20 documentation](https://docs.zephyrproject.org/latest/boards/index.html).
|
| /Zephyr-Core-2.7.6/doc/reference/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.
158 - Changes to the relevant API documentation
221 - API documentation will inform users that the API is deprecated.
237 the corresponding documentation, and communicate the removal in the usual ways:
|
| /Zephyr-Core-2.7.6/ |
| D | CONTRIBUTING.rst | 11 documentation.
34 Coding Style, sanity checks builds, and documentation builds.
|
| D | README.rst | 36 and the documentation's `Getting Started Guide`_ to start developing.
54 * **Documentation**: http://docs.zephyrproject.org (`Getting Started Guide`_)
73 security issues; also see our `Security`_ documentation. Security issues are
79 .. _Zephyr Documentation: http://docs.zephyrproject.org
|
| /Zephyr-Core-2.7.6/doc/_templates/ |
| D | layout.html | 10 This is the documentation for the latest (main) development branch of
11 Zephyr. If you are looking for the documentation of previous releases, use
|
| /Zephyr-Core-2.7.6/doc/releases/ |
| D | release-notes-1.10.rst | 168 Documentation section in Zephyr Kernel 1.10.0
171 * Missing API documentation caused by doxygen subgroups and missing
174 be available from the master branch version of the documentation.
175 * Documentation updated to use CMake (vs. Make) in all examples, and
184 * Continued updates to documentation for new board support, new samples,
186 * Integration of documentation with new zephyrproject.org website.
187 * Documentation moved to docs.zephyrproject.org site (with redirection
217 * :github:`1415` - Problem with forcing new line in generated documentation.
220 * :github:`1425` - spi.h and spi_legacy.h documentation conflicts
223 * :github:`1445` - doc: groups of items in API documentation not displaying
[all …]
|
| D | release-notes-1.7.rst | 139 Documentation section in Zephyr Kernel 1.7.0
144 * New website documentation theme to go with the new zephyrproject.org site.
207 * :jira:`ZEP-823` - New IP Stack - Documentation
242 * :jira:`ZEP-1060` - Contributor guide for documentation missing
325 * :jira:`ZEP-1475` - k_free documentation should specify that NULL is valid
335 * :jira:`ZEP-1493` - Zephyr project documentation copyright
336 * :jira:`ZEP-1495` - Networking API details documentation is missing
344 * :jira:`ZEP-1536` - Convert documentation of PWM samples to RST
345 * :jira:`ZEP-1537` - Convert documentation of power management samples to RST
346 * :jira:`ZEP-1538` - Convert documentation of zoap samples to RST
[all …]
|
| /Zephyr-Core-2.7.6/boards/arm/cc3235sf_launchxl/ |
| D | board.cmake | 3 # See the Zephyr project CC3235SF_LAUNCHXL documentation on
|
| /Zephyr-Core-2.7.6/lib/open-amp/ |
| D | resource_table.c | 24 * Related documentation:
25 * https://www.kernel.org/doc/Documentation/remoteproc.txt
|
| /Zephyr-Core-2.7.6/doc/guides/device_mgmt/ |
| D | dfu.rst | 58 in the `MCUboot with Zephyr`_ documentation page on the MCUboot website.
61 .. _MCUboot with Zephyr: https://mcuboot.com/documentation/readme-zephyr/
|
| /Zephyr-Core-2.7.6/doc/reference/util/ |
| D | index.rst | 6 This page contains reference documentation for ``<sys/util.h>``, which provides
|
| /Zephyr-Core-2.7.6/boards/shields/inventek_eswifi/ |
| D | inventek_eswifi.overlay | 8 * This file is intentionally empty. Please refer to shield documentation for
|
