Commit Graph

71 Commits

Author SHA1 Message Date
Benjamin Cabé
ce4217475b samples: boards: enjoydigital: group Enjoydigital board samples
Group all Enjoydigital board samples in samples/boards/enjoydigital to
keep samples/boards/ organized by vendor

Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
2024-09-13 13:43:09 +02:00
Benjamin Cabé
62a3db704a samples: boards: google: group Google board samples
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>
2024-09-13 13:43:09 +02:00
Benjamin Cabé
e2c1b93a5c samples: boards: intel: group Intel board samples
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>
2024-09-13 13:43:09 +02:00
Benjamin Cabé
b363ff12f1 samples: boards: quicklogic: group quicklogic board samples
Group all Quicklogic board samples in samples/boards/quicklogic to
keep samples/boards/ organized by vendor

Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
2024-09-13 13:43:09 +02:00
Benjamin Cabé
28fe72ea5e samples: boards: stm32: group STM32 board samples
Group all STM32 board samples in samples/boards/st to
keep samples/boards/ organized by vendor

Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
2024-09-13 13:43:09 +02:00
Benjamin Cabé
b3edf89213 samples: boards: microchip: group Microchip board samples
Group all Microchip board samples in samples/boards/96boards to
keep samples/boards/ organized by vendor

Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
2024-09-13 13:43:09 +02:00
Benjamin Cabé
a89ed6595b samples: boards: 96boards: group 96boards board samples
Group all 96boards board samples in samples/boards/96boards to
keep samples/boards/ organized by vendor

Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
2024-09-13 13:43:09 +02:00
Benjamin Cabé
52ee62d962 samples: boards: nxp: group NXP board samples
Group all NXP board samples in samples/boards/nxp to
keep samples/boards/ organized by vendor

Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
2024-09-13 13:43:09 +02:00
Benjamin Cabé
9849845ca3 samples: boards: nrf: group Nordic board samples
Group all Nordic board samples in samples/boards/nordic to
keep samples/boards/ organized by vendor

Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
2024-09-13 13:43:09 +02:00
Benjamin Cabé
b93395fceb samples: boards: espressif: group Espressif board samples
Group all Microchip board samples in samples/boards/espressif to
keep samples/boards/ organized by vendor

Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
2024-09-13 13:43:09 +02:00
Benjamin Cabé
55d9d1c6ba samples: led: consolidate LED samples under same directory
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>
2024-09-05 09:49:52 +02:00
Benjamin Cabé
d77719ee37 doc: redirects: cleanup stale or broken entries
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>
2024-09-04 09:53:35 +02:00
Emil Gydesen
0f5d0f3555 samples: Bluetooth: ISO: Rename ISO central and peripheral
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>
2024-09-02 09:06:18 +02:00
Josuah Demangeon
911abc33e6 samples: move video from subsys to drivers
"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>
2024-08-05 10:17:35 +02:00
Henrik Brix Andersen
370787a227 doc: hardware: peripherals: eeprom: reorganize and add EEPROM shell page
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>
2024-07-08 15:52:21 +02:00
Swift Tian
a86bbd3ebf doc: Add MSPI API documentation
Add the mspi.rst doc and related things for document generation.

Signed-off-by: Swift Tian <swift.tian@ambiq.com>
2024-06-14 21:07:00 -04:00
Jordan Yates
b666262a62 doc: _scripts: gen_devicetree_rest: extra folders
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>
2024-06-12 14:30:14 +03:00
Jordan Yates
ae25d606c9 doc: _scripts: gen_devicetree_rest: skip empty vendors
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>
2024-06-12 14:30:14 +03:00
Tom Burdick
753f8ff0c7 docs: Move sensor.rst to sensor/index.rst
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>
2024-06-05 17:38:56 -05:00
Emil Gydesen
1bcc3d8efa samples: Bluetooth: Audio: Change names to <profile>_<role>
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>
2024-05-31 09:56:11 -05:00
Gerard Marull-Paretas
8120bd7519 samples: move with_mcuboot sample to samples/sysbuild
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>
2024-05-13 16:09:01 -04:00
Emil Gydesen
954eb4face docs: Bluetooth: Audio: Move audio related files to subdir
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>
2024-05-02 16:51:03 +02:00
Paulo Santos
6173f71d42 samples: drivers: adc: naming adc sample
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>
2024-04-24 09:53:18 +02:00
TOKITA Hiroshi
1c4d7e439f doc: scripts: redirects: fix redirect for arduino_uno_r4_minima
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>
2024-04-11 15:51:33 -04:00
Jonathan Rico
6de30457b8 doc: Bluetooth: setup redirects
Setup redirects for pages renamed in #70679 .

Signed-off-by: Jonathan Rico <jonathan.rico@nordicsemi.no>
2024-04-08 09:14:55 -04:00
TOKITA Hiroshi
ddf31820b0 doc: scripts: redirects: fix redirect for led_strip samples
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>
2024-03-28 09:43:05 +00:00
Wajdi ELMuhtadi
b8eceac77b doc: _scripts: redirects: fix redirect for google iot mqtt
fix incorrect redirect for google iot mqtt missing README

Signed-off-by: Wajdi ELMuhtadi <wajdi.elmuhtadi@we-online.com>
2024-02-06 18:57:45 +01:00
Wajdi ELMuhtadi
e5351b0d10 samples: sensor: wsen_hids: remove example for wsen_hids
Remove example for wsen_hids to switch to
generic sensor driver examples.

Signed-off-by: Wajdi ELMuhtadi <wajdi.elmuhtadi@we-online.com>
2024-02-06 18:57:45 +01:00
Wajdi ELMuhtadi
56b70bddcc samples: sensor: wsen_itds: remove example for wsen_itds
Remove example for wsen_itds to switch to
generic sensor driver examples.

Signed-off-by: Wajdi ELMuhtadi <wajdi.elmuhtadi@we-online.com>
2024-02-06 18:57:45 +01:00
Benjamin Cabé
109c53dae8 doc: kconfig: redirect: Add redirects for some old URLs
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
5c88418428

Fixes #66701

Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
2023-12-21 10:02:58 +00:00
Robert Lubos
ffc425191e net: doc: Remove Network Connectivity API page
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>
2023-12-07 10:37:15 +00:00
Fabio Baltieri
33c30795bc doc: redirects: add sorted block checks
Add marker to keep the link list sorted.

Suggested-by: Benjamin Cabé <benjamin@zephyrproject.org>
Signed-off-by: Fabio Baltieri <fabiobaltieri@google.com>
2023-12-06 09:30:55 +00:00
Benjamin Cabé
c1656a4486 doc: redirects: fix redirect for POSIX portability homepage
Add a proper redirect for pre-3.5.99 POSIX portabiltity home page.

Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
2023-11-27 09:23:07 -06:00
Christopher Friedt
3b45235887 doc: posix: structural reorganization of posix docs
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>
2023-11-22 22:47:26 -05:00
Fabio Baltieri
9234088306 samples: kscan_touch: drop the kscan_touch sample
All in-tree touchscreen drivers have been migrated over to input, the
compatibility node has been removed from those boards as well, this
sample can be dropped now.

Signed-off-by: Fabio Baltieri <fabiobaltieri@google.com>
2023-11-20 09:22:03 +01:00
Benjamin Cabé
c26679be42 samples: net: cloud: drop Google Cloud IoT Core
Google Cloud IoT Core has been retired on August 16, 2023.
Removed the sample and the link to it in a previous release note.
Added a redirect to other IoT cloud samples.

Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
2023-09-08 11:04:25 +02:00
Johan Hedberg
e3d5f5072f doc: redirects: Add redirects for renamed Intel boards
The ehl_crb and rpl_crb boards directories were renamed to intel_ehl and
intel_rpl respectively.

Signed-off-by: Johan Hedberg <johan.hedberg@intel.com>
2023-09-01 17:40:30 +02:00
Benjamin Cabé
e6f5c5ea4e doc: Add old toolchain pages to redirects
The toolchain pages have been living in develop/ for a while now.

Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
2023-04-04 10:53:02 -07:00
Gerard Marull-Paretas
38a9833958 doc: redirects: add old sockets page to redirects
The BSD sockets page was moved a while ago when documentation was
reorganized (reported by Nordic technical support). This patch adds a
redirect so that old links keep working just fine.

Signed-off-by: Gerard Marull-Paretas <gerard.marull@nordicsemi.no>
2023-02-14 23:49:40 +09:00
Jamie McCrae
ec7044437e treewide: Disable automatic argparse argument shortening
Disables allowing the python argparse library from automatically
shortening command line arguments, this prevents issues whereby
a new command is added and code that wrongly uses the shortened
command of an existing argument which is the same as the new
command being added will silently change script behaviour.

Signed-off-by: Jamie McCrae <jamie.mccrae@nordicsemi.no>
2023-01-26 20:12:36 +09:00
Gerard Marull-Paretas
9003d7556a doc: scripts: sort redirects alphabetically
Redirects need to be sorted alphabetically, as stated at the beginning
of the file.

Signed-off-by: Gerard Marull-Paretas <gerard.marull@nordicsemi.no>
2022-12-24 16:57:43 +01:00
Gerard Marull-Paretas
2ebdfe1340 doc: scripts: remove legacy redirects
Remove redirects from legacy docs (<1.14).

Signed-off-by: Gerard Marull-Paretas <gerard.marull@nordicsemi.no>
2022-12-24 16:57:43 +01:00
Stephanos Ioannidis
99f1911520 doc: gen_devicetree_rest: Fix binding doc file name resolution
The `binding_filename` function, which resolves the binding
documentation file name from the binding yaml file name, made a very
crude assumption that the binding yaml file name will always have the
extension name of `yaml` -- this is no longer true after the commit
c453220006, which added support for both
`yaml` or `yml`.

This commit reworks the function such that its implementation is not
dependent on the extension name of the binding yaml file.

Signed-off-by: Stephanos Ioannidis <root@stephanos.io>
2022-07-25 15:18:27 +02:00
Kumar Gala
c453220006 doc: gen_devicetree_rest: Fix glob to handle both .yaml and .yml
The glob search was only finding .yaml files, however we do have a
few .yml bindings that got missed.

Signed-off-by: Kumar Gala <galak@kernel.org>
2022-07-15 10:12:46 -07:00
Anas Nashif
798a552daf boards: intel_s1000_crb: remove board/soc
Remove the intel_s1000_crb board. it is no longer available or supported
in the zephyr tree.

Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2022-06-13 16:19:51 -04:00
Anas Nashif
656f87a89f doc: add new redirects
Autogenerated redirects from git diff for new structure.

Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2022-04-07 21:20:17 -04:00
Anas Nashif
e3e67f206c doc: update existing redirects
Change redirects to point to new locations.

Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2022-04-07 21:20:17 -04:00
Nazar Kazakov
f483b1bc4c everywhere: fix typos
Fix a lot of typos

Signed-off-by: Nazar Kazakov <nazar.kazakov.work@gmail.com>
2022-03-18 13:24:08 -04:00
Flavio Ceolin
d2a101cf01 x86: Remove Jailhouse references in this arch
Jailhouse support in X86 was removed long time ago. Just removing some
leftovers.

Signed-off-by: Flavio Ceolin <flavio.ceolin@intel.com>
2022-03-16 04:20:26 -07:00
Gerard Marull-Paretas
483585b6dd doc: delete old kconfig scripts and extensions
These are no longer used.

Signed-off-by: Gerard Marull-Paretas <gerard.marull@nordicsemi.no>
2022-03-02 09:28:37 +01:00