Transition markers ("----") require blank lines before and after, so
this ensures that is always the case.
Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
This change accommodates support for next-generation
soc(it51600).
Tested with:
west build -p always -b it51xxx_evb/it51526aw samples/hello_world/
Signed-off-by: Ren Chen <Ren.Chen@ite.com.tw>
- The vendor of the hexiwear board is mikroe (not nxp)
https://www.mikroe.com/hexiwear.
- Move the board files from 'nxp' to 'mikroe'.
- Delete hexiwear from the nxp maintained board list.
- Update paths in the documentation.
Signed-off-by: Andrej Butok <andrey.butok@nxp.com>
Generate an rst document with an `Examples` section
from the sample nodes written in the examples of the
binding.
Signed-off-by: James Roy <rruuaanng@outlook.com>
Introduce a `language` parameter in `to_code_block()` for syntax
highlighting support (default: None).
Signed-off-by: James Roy <rruuaanng@outlook.com>
Reorganize Bluetooth Classic API documentation by moving existing files
(SDP, RFCOMM, A2DP, HFP) into a new `classic/` subdirectory and adding
new documentation files for L2CAP BR/EDR, AVRCP, GOEP, and BIP.
Changes include:
- Move existing Classic API docs to subdirectory `classic/`
- Add new L2CAP BR/EDR documentation
- Add AVRCP, GOEP, and BIP API reference documentation
- Update HFP documentation to include both HFP Unit and HFP-AG sections
- Update index.rst to reflect new directory structure
- Add Doxygen group documentation to AVRCP header
- Update AVRCP Cover Art to be a subgroup of AVRCP
- Fix L2CAP BR/EDR Doxygen group name and description
Signed-off-by: Lyle Zhu <lyle.zhu@nxp.com>
This moves nvmem docs to a better suited home since we already have
a section for all things storage.
Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
This moves fs docs to a better suited home since we already have
a section for all things storage.
Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
This moves retention into a better suited home since we already have
a section for all things storage.
Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
Pass verbose flag to Twister to get better insights into what boards are
being built and see progress.
Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
This adds a link to the board catalog in the sidebar of each binding
page, directing users to boards using the compatible.
Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
This commits adds a `compatibles` field to each board entry in the board
catalog, similar to the `supported_features` field.
Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
The documentation build shouldn't need to pull in anything beyond what's
active by default in the west.yml manifest. In fact, due to the way the
manifest_projects_table.py script currently works, it is important that
have a local west config that's "vanilla" so that the table of
active/inactive projects is correct.
Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
Remove samples/boards/st/power_mgmt/standby_shutdown.
Sample standby_shutdown in boards/st/power_mgmt includes 2 examples.
One demonstrates wakeup from shutdown using a wakeup pin which is already
implemented in samples/boards/st/power_mgmt/wkup_pins. The other
demonstrates wakeup from SoC STANDBY mode using a wakeup pin. However
it enters SoC STANDBY mode through pm_state_force() whereas
STANDBY mode is not a PM standby or idle state, it is rather a shutdown
with possibly only a unique small SRAM retention, not allowing retention
of the system as expected from Zephyr standby or idle state flavors.
Therefore this second scenario is not applicable and can be removed.
Update doc redirection to link removed sample documentation to ST board
power management related samples documentation.
Signed-off-by: Etienne Carriere <etienne.carriere@st.com>
Converting a "pre-west" Zephyr setup is not something we officially
support anymore so drop associated documentation.
Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
The heuristics for guessing "best" image file for a given board will now
prefer webp over png over jpg as there is a good chance that when we
need to fall back to _any_ image for the lack of a better match, a webp
image, if one exists, will be the best image to use.
Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
When a board or shield is named boardfoo_is_awesome, we now explicitly
look for images with a name that starts with one of the segments of the
board/shield name ; i.e.: boardfoo_is_awesome.imgext, then
boardfoo_is.imgext, then boardfoo.imgext.
Fixes: zephyrproject-rtos/zephyr#96144
Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
Consolidate board documentation into a single page to avoid duplication
and, more importantly, ensure the board documentation is properly
displayed in the documentation website.
Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
Update documentation of native_sim to leverage zephyr-board Shinx magic,
in particular the ability to generate the table of supported HW
features.
Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
Ensure all RST files only ever belong to one single toctree by means of
cleaning up existing in globs used in nested folders.
Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
The PAN B511 evaluation board is a development tool for the
nRF54L15 from Nordic Semiconductor. Due to marketing reasons
the naming was adjusted from panb511 to panb611.
Signed-off-by: Steffen Jahnke <steffen.jahnke@eu.panasonic.com>
Changed the REDIRECTS variable from a list to a tuple in the
redirects.py scripts since it's an immutable sequence.
Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
Add an nPM1304 EK shield, update samples/shields/npm1300_ek to support
both shields, improve the sample description.
Signed-off-by: Sergei Ovchinnikov <sergei.ovchinnikov@nordicsemi.no>
Rather than hardcoding the human readable full names of the archs in the
board catalog, we now retrieve them dynamically from the archs.yml file.
Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
Shield authors can now indicate an optional list of hardware features
that the shield supports, in the form of the same kind of "binding type"
already used for boards.
Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
The hw feature generation takes a long time. The HW_FEATURES_TURBO_MODE
option completely disables hw feature generation. Add a new option
HW_FEATURES_VENDOR_FILTER to be able to selectively enable hw feature
generation only for a given list of vendors. This option is useful
when working on board documentation pages.
Signed-off-by: Aksel Skauge Mellbye <aksel.mellbye@silabs.com>
Declare the dts and binding files used for the supported hardware
directive as dependencies of doc pages that use them.
Signed-off-by: Aksel Skauge Mellbye <aksel.mellbye@silabs.com>
Delete the MAX44009 sensor sample as it's fully generic and does nothing
that's not already in light_polling sample.
Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
Make the recently added `title` attribute in dt bindings available
in the board catalog used by the board supported hardware directive.
Signed-off-by: Aksel Skauge Mellbye <aksel.mellbye@silabs.com>
Commit 38b8790 introduced a pretty bad regression for boards without
revisions. Fix by correctly checking for actually undefined revisions
Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
Use runners.yaml from build metadata to gather info regarding board
supported runners, store the info in the board catalog, and allow
to display it as a table in a board's doc page using the
.. zephyr:board-supported-runner:: directive.
Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
Add a 'title' keyword to the binding to provide a short
description of the binding, while 'description' serves as
the long description.
Signed-off-by: James Roy <rruuaanng@outlook.com>
Boards that have sysbuild enabled in Twister will have the build folder
for the hello_world sample in a subfolder, so update the code
accordingly.
Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
This show a nice widget to switch between the various board targets and
see their respective list of supported features.
The original HTML content of the page is preserved and JavaScript code
"patches" the page on-the-fly. This is so that the actual HTML content
(that e.g. search engines see) is complete and indexable (as well as to
provide useful information for folks who might have JavaScript disabled
altogether).
Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
Revision might be `0` so update the condition to not inadvertently
exclude boards with such revision number.
Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
