Searched +full:doxygen +full:- +full:version (Results 1 – 25 of 42) sorted by relevance
12
| /Zephyr-latest/doc/_extensions/zephyr/ |
| D | api_overview.py | 2 # SPDX-License-Identifier: Apache-2.0
17 of all APIs. This table will show the API name, version and since which
18 version it is present - all information extracted from Doxygen XML output.
24 api_overview_doxygen_xml_dir: Doxygen xml output directory
25 api_overview_doxygen_base_url: Doxygen base html directory
44 version = since = ""
45 github_uri = "https://github.com/zephyrproject-rtos/zephyr/releases/tag/"
54 elif sect.get_kind() == "version":
55 version = sect.get_para()[0].get_valueOf_()
87 version_node = nodes.Text(version)
[all …]
|
| D | doxyrunner.py | 6 SPDX-License-Identifier: Apache-2.0
11 This Sphinx plugin can be used to run Doxygen build as part of the Sphinx build
16 - Doxygen build is run before Sphinx reads input files
17 - Doxyfile can be optionally pre-processed so that variables can be inserted
18 - Changes in the Doxygen input files are tracked so that Doxygen build is only
20 - Synchronizes Doxygen XML output so that even if Doxygen is run only changed,
25 - https://github.com/michaeljones/breathe/issues/420
30 - ``doxyrunner_doxygen``: Path to the Doxygen binary.
31 - ``doxyrunner_doxyfile``: Path to Doxyfile.
32 - ``doxyrunner_outdir``: Doxygen build output directory (inserted to
[all …]
|
| D | doxybridge.py | 4 SPDX-License-Identifier: Apache-2.0
61 """Mapping between Doxygen memberdef kind and Sphinx kinds"""
65 def run(self, **kwargs: Any) -> None:
95 doxygen_target = f"{'_'.join(split[:-1])}.html#{split[-1][1:]}"
154 def parse_compound(inDirName, baseName) -> dict:
197 def doxygen_parse(app: Sphinx) -> None:
218 def setup(app: Sphinx) -> dict[str, Any]:
226 app.connect("builder-inited", doxygen_parse)
229 "version": "0.1",
|
| /Zephyr-latest/doc/contribute/documentation/ |
| D | generation.rst | 11 .. _documentation-overview:
18 using Sphinx to create a formatted stand-alone website. Developers can
36 * Doxygen-generated material used to create all API-specific documents
39 * Script-generated material for kernel configuration options based on Kconfig
51 rtd [shape="rectangle" label="read-the-docs\ntheme"]
56 images -> sphinx
57 rst -> sphinx
58 conf -> sphinx
59 header -> doxygen
60 doxygen -> xml
[all …]
|
| D | guidelines.rst | 24 .. _Sphinx extensions: http://www.sphinx-doc.org/en/stable/contents.html
26 .. _Sphinx Inline Markup: http://sphinx-doc.org/markup/inline.html#inline-markup
30 Sphinx-defined directives and roles used to create the documentation
42 the first non-white space in the preceding line. For example::
50 .. code-block::
66 * Third section heading level (h4) use ``-``
84 For bullet lists, place an asterisk (``*``) or hyphen (``-``) at
113 #. This is a second-level list under the first item (also
143 Multi-column lists
148 a special ``.. rst-class:: rst-columns`` directive. The directive will
[all …]
|
| /Zephyr-latest/doc/ |
| D | zephyr.doxyfile.in | 4 # Doxygen (www.doxygen.org) for a project.
18 # Use Doxygen to compare the used configuration file with the template
20 # doxygen -x [configFile]
21 # Use Doxygen to compare the used configuration file with the template
24 # doxygen -x_noenv [configFile]
26 #---------------------------------------------------------------------------
28 #---------------------------------------------------------------------------
31 # file that follow. The default is UTF-8 which is also the encoding used for all
32 # text before the first occurrence of this tag. Doxygen uses libiconv (or the
35 # The default value is: UTF-8.
[all …]
|
| D | conf.py | 2 # Reference: https://www.sphinx-doc.org/en/master/usage/configuration.html
25 # Add the directory which contains the pytest-twister-pytest
26 sys.path.insert(0, str(ZEPHYR_BASE / "scripts" / "pylib" / "pytest-twister-harness" / "src"))
35 # -- Project --------------------------------------------------------------
38 copyright = "2015-2024 Zephyr Project members and individual contributors"
41 # parse version from 'VERSION' file
42 with open(ZEPHYR_BASE / "VERSION") as f:
56 sys.stderr.write("Warning: Could not extract kernel version\n")
57 version = "Unknown" variable
60 version = ".".join((major, minor, patch)) variable
[all …]
|
| D | CMakeLists.txt | 1 # SPDX-License-Identifier: Apache-2.0
3 cmake_minimum_required(VERSION 3.20.0)
4 project(Zephyr-Kernel-Doc LANGUAGES)
12 #-------------------------------------------------------------------------------
15 set(SPHINXOPTS "-j auto -W --keep-going -T" CACHE STRING "Default Sphinx Options")
17 set(LATEXMKOPTS "-halt-on-error -no-shell-escape" CACHE STRING "Default latexmk options")
26 #-------------------------------------------------------------------------------
29 find_package(Doxygen REQUIRED dot)
31 find_program(SPHINXBUILD sphinx-build)
33 message(FATAL_ERROR "The 'sphinx-build' command was not found")
[all …]
|
| /Zephyr-latest/doc/_extensions/zephyr/doxytooltip/ |
| D | __init__.py | 2 Doxygen Tooltip Extension
6 SPDX-License-Identifier: Apache-2.0
22 def setup(app: Sphinx) -> dict[str, Any]:
26 app.add_js_file("tippy/tippy-bundle.umd.min.js")
32 "version": "0.1",
|
| /Zephyr-latest/.github/workflows/ |
| D | doc-build.yml | 2 # SPDX-License-Identifier: Apache-2.0
8 - cron: '0 */3 * * *'
11 - v*
15 # NOTE: west docstrings will be extracted from the version listed here
22 # and each sphinx-build process may use more than 2GiB of RAM.
26 doc-file-check:
28 runs-on: ubuntu-22.04
30 github.repository_owner == 'zephyrproject-rtos'
32 file_check: ${{ steps.check-doc-files.outputs.any_modified }}
34 - name: checkout
[all …]
|
| D | doc-publish.yml | 3 # SPDX-License-Identifier: Apache-2.0
11 - main
12 - v*
14 - completed
17 doc-publish:
19 runs-on: ubuntu-22.04
23 github.repository == 'zephyrproject-rtos/zephyr'
26 - name: Download artifacts
27 uses: dawidd6/action-download-artifact@v6
29 workflow: doc-build.yml
[all …]
|
| /Zephyr-latest/doc/_doxygen/ |
| D | doxygen-awesome-sidebar-only.css | 3 Doxygen Awesome
4 https://github.com/jothepro/doxygen-awesome-css
8 Copyright (c) 2021 - 2023 jothepro
32 * Make sure it is wide enough to contain the page title (logo + title + version)
34 --side-nav-fixed-width: 335px;
35 --menu-display: none;
37 --top-height: 120px;
38 --toc-sticky-top: -25px;
39 --toc-max-height: calc(100vh - 2 * var(--spacing-medium) - 25px);
43 white-space: nowrap;
[all …]
|
| /Zephyr-latest/doc/releases/ |
| D | release-notes-1.6.rst | 6 We are pleased to announce the release of Zephyr kernel version 1.6.0. This
7 release introduces the unified Kernel replacing the separate nano- and
8 micro-kernels and simplifying the overall Zephyr architecture and programming
10 Support for the ARM Cortex-M0/M0+ family was added and board support for
11 Cortex-M was expanded.
22 * Added support for several ARM Cortex-M boards
34 * Added DLIST to operate in all elements of a doubly-linked list.
52 * ARM: Added support for ARM Cortex-M0/M0+.
55 * x86: Changed IRQ controller to return -1 if cannot determine source vector.
99 * Added raw HCI API to enable physical HCI transport for a Controller-only build.
[all …]
|
| D | release-notes-1.9.rst | 44 We are pleased to announce the release of Zephyr kernel version 1.9.0
49 * Bluetooth Qualification-ready BLE Controller
82 * ARC: Nested interrupt support for normal, non-FIRQ interrupts
90 * arm: Added Olimex STM32-E407 and STM32-P405 boards
91 * arm: Added STM32F412 Nucleo and STM32F429I-DISC1 boards
96 * ARC: Added support for EMSK EM7D v2.2 version (incl. MPU)
116 * net-app API support added. This is higher level API that can be used
126 networking applications using a well-known, cross-platform API
140 * IPSP net-app support: a simplified networking API reducing duplication
143 * BLE controller qualification-ready, with all required tests passing
[all …]
|
| D | release-notes-1.10.rst | 8 We are pleased to announce the release of Zephyr kernel version 1.10.0.
12 * Initial alpha-quality thread-level memory protection on x86, userspace and memory
27 * Initial alpha-quality thread-level memory protection on x86, userspace and memory
35 * Memory domain APIs for fine-tuning memory region permissions
38 * Add the following application-facing memory domain APIs:
40 * k_mem_domain_init() - to initialize a memory domain
41 * k_mem_domain_destroy() - to destroy a memory domain
42 * k_mem_domain_add_partition() - to add a partition into a domain
43 * k_mem_domain_remove_partition() - to remove a partition from a domain
44 * k_mem_domain_add_thread() - to add a thread into a domain
[all …]
|
| D | release-notes-3.0.rst | 8 We are pleased to announce the release of Zephyr RTOS version 3.0.0.
22 * CVE-2021-3835: `Zephyr project bug tracker GHSA-fm6v-8625-99jf
23 <https://github.com/zephyrproject-rtos/zephyr/security/advisories/GHSA-fm6v-8625-99jf>`_
25 * CVE-2021-3861: `Zephyr project bug tracker GHSA-hvfp-w4h8-gxvj
26 <https://github.com/zephyrproject-rtos/zephyr/security/advisories/GHSA-hvfp-w4h8-gxvj>`_
28 * CVE-2021-3966: `Zephyr project bug tracker GHSA-hfxq-3w6x-fv2m
29 <https://github.com/zephyrproject-rtos/zephyr/security/advisories/GHSA-hfxq-3w6x-fv2m>`_
36 <https://github.com/zephyrproject-rtos/zephyr/issues?q=is%3Aissue+is%3Aopen+label%3Abug>`_.
53 * Added ``ranges`` and ``dma-ranges`` as invalid property to be used with DT_PROP_LEN()
58 CRC-16-ANSI checksum. A new function, :c:func:`crc16_reflect`, has been
[all …]
|
| D | release-notes-1.13.rst | 8 We are pleased to announce the release of Zephyr kernel version 1.13.0.
16 * Support for IEEE 802.1AS-2011 generalized Precision Time Protocol (gPTP)
23 * Basic support for Arm TrustZone in Armv8-M
42 * arch: arm: implement ARMv8-M MPU driver
44 * arch: arm: macro API for defining non-secure entry functions
48 * arch: ARM: Change the march used by cortex-m0 and cortex-m0plus
50 * arch: arm: basic Arm TrustZone-M functionality for Cortex-M23 and Cortex-M33
51 * arch: arm: built-in stack protection using Armv8-M SPLIM registers
52 * arch: arm: API for using TT intrinsics in Secure/Non-Secure Armv8-M firmware
63 * riscv32: riscv-privilege: Microsemi Mi-V support
[all …]
|
| D | release-notes-1.11.rst | 8 We are pleased to announce the release of Zephyr kernel version 1.11.0.
12 * Thread-level memory protection on x86, ARC and Arm, userspace and memory
15 * Initial Armv8-M architecture support.
20 * Firmware over-the-air (FOTA) updates over BLE using MCUmgr.
32 * SMP-aware scheduler
47 * Armv8-M initial architecture support, including the following cores:
49 * Arm Cortex-M23
50 * Arm Cortex-M33
74 * Refactored dts.fixup so common SoC-related fixes are in arch/<*>/soc
75 and board dts.fixup is only used for board-specific items.
[all …]
|
| D | release-notes-1.7.rst | 6 We are pleased to announce the release of Zephyr kernel version 1.7.0. This
10 nano- and micro-kernel APIs found in the 1.5.0 release and earlier.
26 kernel version 1.6.0.
52 * Added NXP FRDM-KW41Z board
53 * Added ST Nucleo-F334R8, Nucleo-L476G, STM3210C-EVAL, and STM32373C-EVAL boards
72 This version removes the legacy uIP stack and introduces a new native IP stack.
102 * Created net-shell module for interacting with network sub-system.
124 * Updated TinyCrypt to version 0.2.5
136 * Imported Segger J-Link RTT library
145 * New local-content generation theme (read-the-docs)
[all …]
|
| D | release-notes-1.5.rst | 7 1.5.0. This is the first release to follow the 3-month release cadence.
13 - TCP Support
14 - Integration of the Paho MQTT Library support with QoS
15 - Flash Filesystem Support
16 - Integration of the mbedTLS library for encryption
17 - Improved BR/EDR support (for L2CAP, in particular).
18 - Support for the Altera Nios II/f soft CPU architecture
25 - Added nano_fifo_put_list() APIs, which allows queuing a list of elements
27 - Removed unused memory pool structure field.
28 - Enhanced memory pool code.
[all …]
|
| D | release-notes-4.0.rst | 8 We are pleased to announce the release of Zephyr version 4.0.0.
15 is now the standard way to provide device-specific protection to data at rest. (:github:`76222`)
18 :ref:`ZMS <zms_api>` is a new key-value storage subsystem compatible with all non-volatile storage
25 runtime configuration through vendor specific APIs. Initially the :dtcompatible:`nordic,nrf-comp`,
26 :dtcompatible:`nordic,nrf-lpcomp` and :dtcompatible:`nxp,kinetis-acmp` are supported.
31 Initially implemented drivers include a simple :dtcompatible:`zephyr,gpio-steppers` and a complex
32 sensor-less stall-detection capable with integrated ramp-controller :dtcompatible:`adi,tmc5041`.
50 directory for :zephyr:code-sample-category:`code samples <samples>`.
70 * :cve:`2024-8798`: Under embargo until 2024-11-22
71 * :cve:`2024-10395`: Under embargo until 2025-01-23
[all …]
|
| D | release-notes-3.6.rst | 8 We are pleased to announce the release of Zephyr version 3.6.0.
12 * New :ref:`GNSS subsystem <gnss_api>` added, enabling geo-awareness in Zephyr applications.
13 * New API and drivers introduced for interfacing with :ref:`keyboard matrices <gpio-kbd>`.
16 * Integrated Trusted Firmware-M (TF-M) 2.0, including an update to Mbed TLS 3.5.2.
23 * Over 30 new supported boards, spanning all Zephyr-supported architectures.
37 * CVE-2023-5779 `Zephyr project bug tracker GHSA-7cmj-963q-jj47
38 <https://github.com/zephyrproject-rtos/zephyr/security/advisories/GHSA-7cmj-963q-jj47>`_
40 * CVE-2023-6249 `Zephyr project bug tracker GHSA-32f5-3p9h-2rqc
41 <https://github.com/zephyrproject-rtos/zephyr/security/advisories/GHSA-32f5-3p9h-2rqc>`_
43 * CVE-2023-6749 `Zephyr project bug tracker GHSA-757h-rw37-66hw
[all …]
|
| D | release-notes-3.7.rst | 8 We are pleased to announce the release of Zephyr version 3.7.0.
10 This release is the last non-maintenance 3.x release and, as such, will be the next
18 * A long-awaited :ref:`HTTP Server <http_server_interface>` library, and associated service API,
21 * :ref:`POSIX support <posix_support>` has been extended, with most Options of the IEEE 1003-2017
25 * Bluetooth Host has been extended with support for the Nordic UART Service (NUS), Hands-free Audio
29 :ref:`read-then-decode approach <sensor-read-and-decode>` that enables more types of sensors and
35 * Trusted Firmware-M (TF-M) 2.1.0 and Mbed TLS 3.6.0 have been integrated into Zephyr.
39 1588) allows to synchronize time across devices with sub-microsecond accuracy.
52 * 1-Wire
71 :ref:`pinctrl-guide` for more details.
[all …]
|
| /Zephyr-latest/boards/intel/socfpga_std/cyclonev_socdk/doc/ |
| D | index.rst | 37 * J26: Short pins 1-2
38 * J27: Short pins 2-3
39 * J28: Short pins 1-2
40 * J29: Short pins 2-3
41 * J30: Short pins 1-2
48 * SW3: ON-OFF-ON-OFF-ON-ON
49 * SW4: OFF-OFF-ON-ON
51 Other switches are user switches, their position is application-specific.
58 ….intel.com/content/www/us/en/software-kit/684215/intel-quartus-prime-lite-edition-design-software-…
66 .. code-block:: console
[all …]
|
| /Zephyr-latest/doc/contribute/ |
| D | bin_blobs.rst | 1 .. _bin-blobs:
12 Zephyr supports downloading and using third-party binary blobs via its built-in
15 `upstream (vanilla) Zephyr <https://github.com/zephyrproject-rtos/zephyr>`_.
18 the support for binary blobs in forks or third-party distributions of Zephyr. In
21 therefore free to create Zephyr-based downstream software which uses binary
30 click-through or other EULA-like workflow when users fetch and install blobs.
35 Blobs must be hosted on the Internet and managed by third-party infrastructure.
45 Blobs are fetched from official third-party sources by the :ref:`west blobs
46 <west-blobs>` command.
49 <modules-bin-blobs>` files included in separate Zephyr :ref:`module repositories
[all …]
|
12
