Add a CLI argument for specifying individual files to be added to the
parsing. This is useful for downstream users that wish to import files
such as `bindings/spi/spi-device.yaml`, without also pulling in all the
associated SPI controllers.
Signed-off-by: Jordan Yates <jordan@embeint.com>
The API directory really isn't the best place for shell
documentation, which isn't API.
Created a new directory for Bluetooth shell documentation
and moved the ISO and LE Audio docs in there.
The existing bluetooth-shell.rst file was also split into
several new files, so that it follows the same structure.
Signed-off-by: Emil Gydesen <emil.gydesen@nordicsemi.no>
Fixes: #69548
Support extending an existing board with new board variants.
This commit introduces the following changes to allow a board to be
extended out-of-tree.
The board yaml schema is extended to support an extend field which
will be used to identify the board to be extended.
A board 'plank' can be extended like this:
> board:
> extend: plank
> variants:
> - name: ext
> qualifier: soc1
For the rest of the build system this means that there is no longer a
single board directory.
The existing CMake variable BOARD_DIR is kept and reference the
directory which defines the board.
A new CMake variable BOARD_DIRECTORIES provides a list of all
directories which defines board targets for the board.
This means the directory which defines the board as well as all
directories that extends the board.
Signed-off-by: Torsten Rasmussen <Torsten.Rasmussen@nordicsemi.no>
For easier recognition PHYTEC boards have been prefixed with the SoC name.
As the new hardware model includes the SoC and cpu, this prefixing is not
needed anymore. All PHYTEC eval boards have an individual and unique name
and can be found easily via this name.
Signed-off-by: Jonas Remmert <j.remmert@phytec.de>
For easier recognition PHYTEC boards have been prefixed with the SoC name.
As the new hardware model includes the SoC and cpu, this prefixing is not
needed anymore. All PHYTEC eval boards have an individual and unique name
and can be found easily via this name.
Signed-off-by: Jonas Remmert <j.remmert@phytec.de>
hwmv2 established a convention that boards live in a folder named after
the vendor prefix.
RAK Wireless boards apparently missed the memo :)
Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
Boards under a folder that doesn't directly match a vendor prefix
incorrectly end up being categorized as "zephyr" since that's the only
prefix that is eventually found when navigating up the folder hierarchy.
This commits treats boards in the "others" and "native" folders as
special cases and associates them to an "Unknown/Other" category.
Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
This might be a leftover from a previous version but this is basically
silencing all Sphinx logs when generating the catalog from Sphinx -- not
good!
Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
This makes dictionary entries from the boards catalog more
self-contained as the name of the board is now included in the entry.
Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
Small change to the way image are stored in the catalog so that we know
where the source image is rather than anticipating on the final path
after build has happened. This allows to potentially reference the
source image from e.g. directives.
Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
Store soc(s) information for each board in the catalog, as
well as populate a tree structure for the full list of
family->series->soc.
Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
Now that we have full_name available in board.yml, stop trying
to "guess" full/commercial name of the board based on its
documentation.
Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
This commit adds support for generating an interactive catalog of all
the supported boards that can be included in the documentation using
the `.. zephyr:board-catalog::` directive.
Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
When generating the documentation pages for the devicetree bindings, add
a link to the .c file implementing the corresponding driver, or folder
likely to contain the driver implementation, using heuristics to
determine the most likely location of the driver sources.
Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
Group all Enjoydigital board samples in samples/boards/enjoydigital to
keep samples/boards/ organized by vendor
Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
Group all Google board samples in samples/boards/google to
keep samples/boards/ organized by vendor
Added zephyr-code-sample directive to twinkie sample
Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
Group all Intel board samples in samples/boards/intel to
keep samples/boards/ organized by vendor
Added missing code-sample directive to the code relocation sample.
Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
Group all Quicklogic board samples in samples/boards/quicklogic to
keep samples/boards/ organized by vendor
Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
Group all STM32 board samples in samples/boards/st to
keep samples/boards/ organized by vendor
Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
Group all Microchip board samples in samples/boards/96boards to
keep samples/boards/ organized by vendor
Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
Group all 96boards board samples in samples/boards/96boards to
keep samples/boards/ organized by vendor
Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
Group all NXP board samples in samples/boards/nxp to
keep samples/boards/ organized by vendor
Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
Group all Nordic board samples in samples/boards/nordic to
keep samples/boards/ organized by vendor
Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
Group all Microchip board samples in samples/boards/espressif to
keep samples/boards/ organized by vendor
Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
With over a dozen LED samples, grouping them in a common drivers/led/
folder helps keep things tidy and lays the groundwork for further
improvements in the way samples are showing up in the docs.
Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
Fixed entries pointing to invalid destinations either due to resource
having been removed or moved once more, or entries being plain broken
from day 1.
Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
The samples had a _iso suffix, but the other ISO samples
prefix iso_.
Renames the central and peripheral sample so that they
prefix iso_ rather than suffix _iso.
Signed-off-by: Emil Gydesen <emil.gydesen@nordicsemi.no>
"Video subsystem for Zephyr" is actually only defined as a driver
and the examples actually include <zephyr/drivers/video.h>.
Signed-off-by: Josuah Demangeon <me@josuah.net>
Reorganize the EEPROM periheral documentation to make room for subpages
with additional details. Add a page describing the EEPROM shell module.
Signed-off-by: Henrik Brix Andersen <hebad@vestas.com>
Add an option to specify particular folders to pull bindings from
when generating documentation. This is useful for downstream projects
that may want to document their own bindings, but don't want to pull in
every Zephyr binding.
This is not currently possible as almost every binding depends on
`base.yaml`, which exists in the Zephyr repository. This is now enabled
by adding the following to `DTS_ARGS` in the downstream `CMakeLists.txt`
file: `--dts-folder ${ZEPHYR_BASE}/dts/bindings/base`.
Signed-off-by: Jordan Yates <jordan@embeint.com>
Don't create output sections for vendors without bindings. This only
affects the `Unknown vendor` and `Generic or vendor-independent`
vendors, which are populated by default but do not necessarily contain
any entries.
Signed-off-by: Jordan Yates <jordan@embeint.com>
Looking to expand the sensor docs and break out significant sections.
First though to move this to a directory to allow for multiple sensor
related rst docs.
Signed-off-by: Tom Burdick <thomas.burdick@intel.com>
Modify the BAP and PBP samples to start with the profile name
(BAP or PBP) and the role of the sample.
Signed-off-by: Emil Gydesen <emil.gydesen@nordicsemi.no>
This creates a new category of samples that demonstrate certain features
of sysbuild. "application development" was a very generic name.
Signed-off-by: Gerard Marull-Paretas <gerard@teslabs.com>
Add a new subdir, audio, and move all the audio related
documentation files to that directory, similar to mesh.
Signed-off-by: Emil Gydesen <emil.gydesen@nordicsemi.no>
The adc sample was in the root directory of the adc samples.
Move all the files to a subdirectory adc_dt.
Signed-off-by: Paulo Santos <pauloroberto.santos@edge.ufal.br>
The directory name in boards has been changed with the addition of
support for Arduino UNO R4 WiFi, so add a redirect from
boards/arduino/uno_r4_minima to boards/arduino/uno_r4.
Signed-off-by: TOKITA Hiroshi <tokita.hiroshi@fujitsu.com>
Since I have integrated some samples into samples/drivers/led_strip,
seting up redirection from the deleted apa102, lpd8806, and ws2812.
Signed-off-by: TOKITA Hiroshi <tokita.hiroshi@gmail.com>
Documentation pages around Kconfig have moved around on a couple of
occasions in the past [1] [2] and current redirects were dysfonctional
(leading /) and incomplete, while an entire set of redirects was also
missing. This notably fixes the "browse latest development version of
this page" link on
https://docs.zephyrproject.org/2.7.5/guides/build/kconfig/tips.html or a
link to the "Kconfig tips" page as found in Kconfiglib's current README
(https://pypi.org/project/kconfiglib/)
[1] commit 5342bc64dd [2] commit
5c88418428Fixes#66701
Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
The Network Connectivity API page is kind of pointless, as it provides
little information (which can be found elsewhere as well) and it was
pointer out that it kind of creates noise in the documentation as it can
be confused with the page which provides a summary of network APIs.
Therefore, remove the page, and move the information from it elsewhere.
The brief summary of what APIs to use was moved the Networking APIs
index page. The information about the samples demonstrating BSD sockets
API usage was moved to the BSD sockets documentation page itself.
Signed-off-by: Robert Lubos <robert.lubos@nordicsemi.no>
Add marker to keep the link list sorted.
Suggested-by: Benjamin Cabé <benjamin@zephyrproject.org>
Signed-off-by: Fabio Baltieri <fabiobaltieri@google.com>
Revise the structure of the POSIX API docs. This separates
related items out to dedicated pages. Further improvements
could yet be made - e.g. using the 'collapse' feature to
expand and collapse large sections of text or tables.
Signed-off-by: Christopher Friedt <cfriedt@meta.com>
