Commit Graph

13 Commits

Author SHA1 Message Date
Benjamin Cabé
de13103f0b boards: doc: adopt zephyr:board-supported-runners directive
Add .. zephyr:board-supported-runners:: to the Programming and Debugging
section of the documentation for each board that has one such section,
as this is the most natural place to put it.

Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
2025-04-03 21:05:39 +02:00
Benjamin Cabé
8d96de75a4 doc: espressif: adopt zephyr:board-supported-hw directive
Replace manually authored hardware features table with the new Zephyr
board supported hardware directive which automatically generates an
up-to-date table based on the boards' Devicetree.

Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
2025-03-05 21:54:59 +00:00
Marek Matej
207da3ad15 doc: espressif: Add missing images
Update and add missing Espressif board images.

Signed-off-by: Marek Matej <marek.matej@espressif.com>
2024-11-08 22:28:30 -06:00
Benjamin Cabé
f0ec6ada1d boards: espressif: adopt new zephyr:board directive and role
This updates the documentation of all the Espressif boards to use
the new `zephyr:board::` directive.

Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
2024-10-24 17:51:15 +02:00
Benjamin Cabé
bbdf72f015 doc: boards: add target-notes directive where missing
For the "References" section to be useful, it needs to include a call to
the target-notes directive, which is the one that actually generates the
list of references made in the current document.

Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
2024-10-23 15:30:44 -05:00
Benjamin Cabé
9a16b93868 samples: hello_world: use zephyr:code-sample directive
Adds missing code-sample directive to the Hello World sample in
preparation for upcoming changes to the Zephyr documentation that will
be leveraging the provided description and metadata.

Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
2024-09-16 10:05:18 +02:00
Sylvio Alves
6654c2a2f6 boards: esp32-based: update documentation
This PR updates all Espressif board names to meet its
original value. It also update reference links, re-organize
entries and removes unused content.

This also fixes bootloader information regarding a few boards.
IDF Bootloader was removed and these boards kept that info.
This updated it accordingly with the Simpleboot Bootloader.

Signed-off-by: Sylvio Alves <sylvio.alves@espressif.com>
2024-09-10 21:52:49 -04:00
Benjamin Cabé
34982bb00b doc: samples: use :zephyr-app: for in-tree samples
The zephyr-app-commands directive can output a helpful hint to the user
when they are trying to build a sample that is in the Zephyr tree,
telling them to ensure they are in the root folder of the Zephyr repo.

Update all doc pages that were using :app: instead of :zephyr-app: so
that the hint is displayed.

Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
2024-09-05 17:18:05 -04:00
Anas Nashif
82613fba11 doc: fix trivial typo
fix 'be build' and replace with 'be built'.

Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2024-09-05 09:49:18 +02:00
Benjamin Cabé
5a07cf4e0d doc: esp32: fix rendering of MCUboot note
Use proper syntax to ensure rendering of the
CONFIG_BOOTLOADER_MCUBOOT snippet is correct.

Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
2024-07-01 18:12:43 +02:00
Sylvio Alves
8adec6d749 boards: docs: remove extra table line
Remove extra table line present in a few esp32-based board
to meet default style.

Signed-off-by: Sylvio Alves <sylvio.alves@espressif.com>
2024-06-14 19:12:29 +02:00
Marek Matej
b29be06ec2 boards: espressif: Update documentation
Update the booting information in recently added
Espressif boards to include simple boot method.

Signed-off-by: Marek Matej <marek.matej@espressif.com>
2024-04-10 11:29:45 -04:00
Marcio Ribeiro
f23d06e344 boards: esp32s2_devkitc: initial board support
Initial board files created to support the esp32s2_devkitc board.

Signed-off-by: Marcio Ribeiro <marcio.ribeiro@espressif.com>
2024-04-08 09:17:18 -04:00