Skip to content

Commit b58b896

Browse files
kartbenaescolar
authored andcommitted
boards: seeed: adopt new zephyr:board directive and role
This updates the documentation of all the Seeed Studio boards to use the new `zephyr:board::` directive. Signed-off-by: Benjamin Cabé <[email protected]>
1 parent ecb7c87 commit b58b896

File tree

11 files changed

+18
-73
lines changed

11 files changed

+18
-73
lines changed

boards/seeed/lora_e5_dev_board/doc/lora_e5_dev_board.rst

Lines changed: 1 addition & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,4 @@
1-
.. _lora_e5_dev_board:
2-
3-
Seeed Studio LoRa-E5 Dev Board
4-
##############################
1+
.. zephyr:board:: lora_e5_dev_board
52
63
Overview
74
********
@@ -13,10 +10,6 @@ The LoRa-E5-HF STM32WLE5JC Module supports multiple LPWAN protocols on the
1310
All GPIOs of the LoRa-E5 Module are laid out supporting
1411
various data protocols and interfaces including RS-485 and Grove.
1512

16-
.. image:: img/lora_e5_dev_board.jpg
17-
:align: center
18-
:alt: LoRa-E5 Dev board
19-
2013
Hardware
2114
********
2215

boards/seeed/lora_e5_mini/doc/index.rst

Lines changed: 1 addition & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,4 @@
1-
.. _lora_e5_mini:
2-
3-
Seeed Studio LoRa-E5 mini
4-
#########################
1+
.. zephyr:board:: lora_e5_mini
52
63
Overview
74
********
@@ -10,10 +7,6 @@ LoRa-E5 mini is a compacted-sized development board suitable for the rapid
107
testing and building of small-sized LoRa device, exposing all capabilities of
118
Seeed Studio LoRa-E5 STM32WLE5JC module.
129

13-
.. image:: img/lora_e5_mini.jpg
14-
:align: center
15-
:alt: LoRa-E5 mini
16-
1710
Hardware
1811
********
1912

boards/seeed/seeeduino_xiao/doc/index.rst

Lines changed: 1 addition & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,4 @@
1-
.. _seeeduino_xiao:
2-
3-
Seeeduino XIAO
4-
##############
1+
.. zephyr:board:: seeeduino_xiao
52
63
Overview
74
********
@@ -10,10 +7,6 @@ The Seeeduino XIAO is a tiny (20 mm x 17.5 mm) ARM development
107
board with onboard LEDs, USB port, and range of I/O broken out
118
onto 14 pins.
129

13-
.. image:: img/seeeduino_xiao.jpg
14-
:align: center
15-
:alt: Seeeduino XIAO
16-
1710
Hardware
1811
********
1912

boards/seeed/wio_terminal/doc/index.rst

Lines changed: 1 addition & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,4 @@
1-
.. _wio_terminal:
2-
3-
Wio Terminal
4-
############
1+
.. zephyr:board:: wio_terminal
52
63
Overview
74
********
@@ -11,11 +8,6 @@ wireless connectivity (2.4G/5G dual-band Wi-Fi and BLE 5.0), LCD display,
118
USB C port, FPC connector, microSD card slot, Raspberry Pi compatible 40-pins
129
header and 2 Grove connectors.
1310

14-
.. image:: img/wio_terminal.png
15-
:width: 500px
16-
:align: center
17-
:alt: Seeed Studio Wio Terminal
18-
1911
Hardware
2012
********
2113

boards/seeed/xiao_ble/doc/index.rst

Lines changed: 1 addition & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,4 @@
1-
.. _xiao_ble:
2-
3-
XIAO BLE (Sense)
4-
################
1+
.. zephyr:board:: xiao_ble
52
63
Overview
74
********
@@ -10,10 +7,6 @@ The Seeed XIAO BLE (Sense) is a tiny (21 mm x 17.5 mm) Nordic Semiconductor
107
nRF52840 ARM Cortex-M4F development board with onboard LEDs, USB port, QSPI
118
flash, battery charger, and range of I/O broken out into 14 pins.
129

13-
.. figure:: img/xiao_ble.jpg
14-
:align: center
15-
:alt: XIAO BLE
16-
1710
Hardware
1811
********
1912

boards/seeed/xiao_esp32c3/doc/index.rst

Lines changed: 1 addition & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,4 @@
1-
.. _xiao_esp32c3:
2-
3-
XIAO ESP32C3
4-
############
1+
.. zephyr:board:: xiao_esp32c3
52
63
Overview
74
********
@@ -11,12 +8,6 @@ Espressif ESP32-C3 WiFi/Bluetooth dual-mode chip.
118

129
For more details see the `Seeed Studio XIAO ESP32C3`_ wiki page.
1310

14-
.. figure:: img/xiao_esp32c.jpg
15-
:align: center
16-
:alt: XIAO ESP32C3
17-
18-
XIAO ESP32C3
19-
2011
Hardware
2112
********
2213

boards/seeed/xiao_esp32s3/doc/index.rst

Lines changed: 1 addition & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,4 @@
1-
.. _xiao_esp32s3:
2-
3-
XIAO ESP32S3
4-
############
1+
.. zephyr:board:: xiao_esp32s3
52
63
Overview
74
********
@@ -11,12 +8,6 @@ Espressif ESP32-S3 WiFi/Bluetooth dual-mode chip.
118

129
For more details see the `Seeed Studio XIAO ESP32S3`_ wiki page.
1310

14-
.. figure:: img/xiao_esp32s3.jpg
15-
:align: center
16-
:alt: XIAO ESP32S3
17-
18-
XIAO ESP32S3
19-
2011
Hardware
2112
********
2213

boards/seeed/xiao_rp2040/doc/index.rst

Lines changed: 1 addition & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,4 @@
1-
.. _xiao_rp2040:
2-
3-
XIAO RP2040
4-
###########
1+
.. zephyr:board:: xiao_rp2040
52
63
Overview
74
********
@@ -13,12 +10,6 @@ to be flashed without any adapter, in a drag-and-drop manner.
1310

1411
For more details see the `Seeed Studio XIAO RP2040`_ wiki page.
1512

16-
.. figure:: img/xiao_rp2040.webp
17-
:align: center
18-
:alt: XIAO RP2040
19-
20-
XIAO RP2040
21-
2213
Hardware
2314
********
2415

doc/contribute/documentation/guidelines.rst

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1201,6 +1201,14 @@ Boards
12011201
12021202
This role is used to reference a board documented using :rst:dir:`zephyr:board`.
12031203

1204+
For example::
1205+
1206+
Check out :zephyr:board:`wio_terminal` for more information.
1207+
1208+
Will render as:
1209+
1210+
Check out :zephyr:board:`wio_terminal` for more information.
1211+
12041212
.. rst:directive:: .. zephyr:board-catalog::
12051213
12061214
This directive is used to generate a catalog of Zephyr-supported boards that can be used to

doc/releases/release-notes-3.7.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -410,7 +410,7 @@ Boards & SoC Support
410410
* Added support for :ref:`Ambiq Apollo3 Blue board <apollo3_evb>`: ``apollo3_evb``.
411411
* Added support for :ref:`Ambiq Apollo3 Blue Plus board <apollo3p_evb>`: ``apollo3p_evb``.
412412
* Added support for :ref:`Raspberry Pi 5 board <rpi_5>`: ``rpi_5``.
413-
* Added support for :ref:`Seeed Studio XIAO RP2040 board <xiao_rp2040>`: ``xiao_rp2040``.
413+
* Added support for :zephyr:board:`Seeed Studio XIAO RP2040 board <xiao_rp2040>`: ``xiao_rp2040``.
414414
* Added support for :ref:`Mikroe RA4M1 Clicker board <mikroe_clicker_ra4m1>`: ``mikroe_clicker_ra4m1``.
415415
* Added support for :ref:`Arduino UNO R4 WiFi board <arduino_uno_r4>`: ``arduino_uno_r4_wifi``.
416416
* Added support for :ref:`Renesas EK-RA8M1 board <ek_ra8m1>`: ``ek_ra8m1``.

0 commit comments

Comments
 (0)