Make it possible to cross reference documentation for various harnesses
by adding target locations.
Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
Add note in release notes for v4.2 about de-deprecation of
CONFIG_CONFIG_UART_x_NRF_HW_ASYNC option.
Signed-off-by: Krzysztof Chruściński <krzysztof.chruscinski@nordicsemi.no>
Add a note about STM32 boards TF-M BL2 bootloader that do not embed
HW crypto drivers since migration to TF-M v2.2.
Signed-off-by: Etienne Carriere <etienne.carriere@st.com>
The recommended back-end depends on the use case. There exists another note
(recommendation) in doc/services/storage/settings/index.rst which is up to
date.
Signed-off-by: Jeppe Odgaard <jeppe.odgaard@prevas.dk>
The migration guide mentions NET_REQUEST_ETHERNET_GET_QAV_PARAM twice
in a row. One instance should be NET_REQUEST_ETHERNET_SET_QAV_PARAM.
Signed-off-by: Christoph Mair <christoph.mair@husqvarnagroup.com>
Commit a0b746 deleted 2 deprecated driver init levels (EARLY,
APPLICATION), but didn't update the number mentioned in the doc.
Signed-off-by: Nabil Elqatib <nabilelqatib@gmail.com>
Add 4.2.0 release notes for networking and move the PM section which
somehow ended up inside Networking.
Signed-off-by: Robert Lubos <robert.lubos@nordicsemi.no>
Fixed selectors that probably went stale overtime since the custom.css
was adopted from Godot and RTD having evolved in the meantime and that
were causing +/- icons to expand/collapse the navtree to be putting
margins where they shouldn't have.
Fixeszephyrproject-rtos/zephyr#78974
Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
Another take on zephyrproject-rtos/zephyr#76953.
This uses STRIP_FROM_INC_PATH to make sure #include snippets in the
documentation are not absolute paths and reflect what one would
actually use in their code.
Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
Use :c:func:`xxx` and :c:type:`xxx` when applicable, as well as reword
a deprecation to make the replacement appear.
Signed-off-by: Josuah Demangeon <me@josuah.net>
Fix issues with Doxygen 1.14 and dark theme. Upstream PRs to
doxygen-awesome will be submitted in parallel.
Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
In order to make it easier for folks to discover available twister
options when using/searching the documentation, or when making external
search in their favorite search engine, inline the output of
`twister --help` into the docs so as to have an always up-to-date
and searchable snapshot of it.
Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
This introduces the release notes and migration guide for Zephyr 4.3.0
earlier so that people have a placeholder to start adding content as
they line up pull requests for the 4.3 release.
Signed-off-by: Martin Hoff <martin.hoff@silabs.com>
Doxygen 1.14 comes with really useful UX improvements which we want to
benefit from in our API documentation so update the CI job accordingly.
Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
- Installing python3-venv should be done right when all dependencies are
installed.
- Installing python3-venv is enough to pull wheel, setuptools
(python3-setuptools-whl), and pip (python3-pip-whl) so that they are
available in the venv, so reduce the list of packages to install
accordingly.
Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
Ubuntu 20.04 has entered "security fixes only" mode since May 2025, so
we can simplify the getting started guide by making the instructions
apply to 22.04 and onwards, and remove the instructions for adding
Kitware APT repository in the process.
Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
When building the docs for a release, the section of the getting started
that lets the user `west init` their workspace now has them check out
the version matchin the release.
Fixeszephyrproject-rtos/zephyr#92163
Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
Add references to new API, functions, devicetree bindings introduced
from introduction of the UVC class.
Signed-off-by: Josuah Demangeon <me@josuah.net>
This reverts commit 043bb58488.
Note that scripts/requirements-actions.txt might not be 100% the same
as what was pinned prior to the revert due to it being difficult to
restore previous versions while also accounting for the new dependencies
that were added in the meantime.
Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
Fix a broken link in the 'contribute/proposals_and_rfcs.rst' file that
pointed to a non-existent Markdown RFC template.
The link previously pointed to:
.github/ISSUE_TEMPLATE/003_rfc-proposal.md
It has been corrected to point to the actual YAML file:
.github/ISSUE_TEMPLATE/003_rfc-proposal.yml
Fixes: #92342
Signed-off-by: Gaetan Perrot <gaetan.perrot@spacecubics.com>
The LTDC RGB565 format corresponds to the PIXEL_FORMAT_BGR565 format.
Update the LTDC driver to advertise PIXEL_FORMAT_BGR565 as the supported
format instead of PIXEL_FORMAT_RGB565. This change ensures correct color
rendering in the sample display application and enables usage of the
video capture sample application.
Signed-off-by: Alain Volmat <alain.volmat@foss.st.com>
Clarify expectations about the recently modified default variant of the
board.
Update migration guide to warn existing users about the change.
Signed-off-by: Erwan Gouriou <erwan.gouriou@st.com>
Emphasize the role of maintainers in upholding the project's code of
conduct and fostering an inclusive environment for all.
Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
Add information about hostap IPC mechanism change that can save up to
6-8 kB memory when using native wifi stack.
Signed-off-by: Jukka Rissanen <jukka.rissanen@nordicsemi.no>
Utilize a code spell-checking tool to scan for and correct spelling errors
in various files within the `doc` directory.
In `dsa_txrx_process.svg`, correct the typo `Tansmit` to `Transmit`.
Signed-off-by: Pisit Sawangvonganan <pisit@ndrsolution.com>
This snippet got introduced, and is not a breaking change for C APIs but
still introduce a change of command line to use for building projects,
so add a migration guide entry.
Signed-off-by: Josuah Demangeon <me@josuah.net>
