adafruit-mirror/zephyr
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions 9

boards: seeed: adopt new zephyr:board directive and role

Browse source 
This updates the documentation of all the Seeed Studio boards to use
the new `zephyr:board::` directive.

Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
This commit is contained in:
Benjamin Cabé 2024-10-19 11:04:40 +02:00 committed by Alberto Escolar
parent ecb7c875dd
commit b58b8964d3
11 changed files with 18 additions and 73 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

9
boards/seeed/lora_e5_dev_board/doc/lora_e5_dev_board.rst
View file

@ -1,7 +1,4 @@
.. _lora_e5_dev_board:
Seeed Studio LoRa-E5 Dev Board
##############################
.. zephyr:board:: lora_e5_dev_board
Overview
********
@ -13,10 +10,6 @@ The LoRa-E5-HF STM32WLE5JC Module supports multiple LPWAN protocols on the
All GPIOs of the LoRa-E5 Module are laid out supporting
various data protocols and interfaces including RS-485 and Grove.
.. image:: img/lora_e5_dev_board.jpg
:align: center
:alt: LoRa-E5 Dev board
Hardware
********

9
boards/seeed/lora_e5_mini/doc/index.rst
View file

@ -1,7 +1,4 @@
.. _lora_e5_mini:
Seeed Studio LoRa-E5 mini
#########################
.. zephyr:board:: lora_e5_mini
Overview
********
@ -10,10 +7,6 @@ LoRa-E5 mini is a compacted-sized development board suitable for the rapid
testing and building of small-sized LoRa device, exposing all capabilities of
Seeed Studio LoRa-E5 STM32WLE5JC module.
.. image:: img/lora_e5_mini.jpg
:align: center
:alt: LoRa-E5 mini
Hardware
********

9
boards/seeed/seeeduino_xiao/doc/index.rst
View file

@ -1,7 +1,4 @@
.. _seeeduino_xiao:
Seeeduino XIAO
##############
.. zephyr:board:: seeeduino_xiao
Overview
********
@ -10,10 +7,6 @@ The Seeeduino XIAO is a tiny (20 mm x 17.5 mm) ARM development
board with onboard LEDs, USB port, and range of I/O broken out
onto 14 pins.
.. image:: img/seeeduino_xiao.jpg
:align: center
:alt: Seeeduino XIAO
Hardware
********

10
boards/seeed/wio_terminal/doc/index.rst
View file

@ -1,7 +1,4 @@
.. _wio_terminal:
Wio Terminal
############
.. zephyr:board:: wio_terminal
Overview
********
@ -11,11 +8,6 @@ wireless connectivity (2.4G/5G dual-band Wi-Fi and BLE 5.0), LCD display,
USB C port, FPC connector, microSD card slot, Raspberry Pi compatible 40-pins
header and 2 Grove connectors.
.. image:: img/wio_terminal.png
:width: 500px
:align: center
:alt: Seeed Studio Wio Terminal
Hardware
********

9
boards/seeed/xiao_ble/doc/index.rst
View file

@ -1,7 +1,4 @@
.. _xiao_ble:
XIAO BLE (Sense)
################
.. zephyr:board:: xiao_ble
Overview
********
@ -10,10 +7,6 @@ The Seeed XIAO BLE (Sense) is a tiny (21 mm x 17.5 mm) Nordic Semiconductor
nRF52840 ARM Cortex-M4F development board with onboard LEDs, USB port, QSPI
flash, battery charger, and range of I/O broken out into 14 pins.
.. figure:: img/xiao_ble.jpg
:align: center
:alt: XIAO BLE
Hardware
********

11
boards/seeed/xiao_esp32c3/doc/index.rst
View file

@ -1,7 +1,4 @@
.. _xiao_esp32c3:
XIAO ESP32C3
############
.. zephyr:board:: xiao_esp32c3
Overview
********
@ -11,12 +8,6 @@ Espressif ESP32-C3 WiFi/Bluetooth dual-mode chip.
For more details see the `Seeed Studio XIAO ESP32C3`_ wiki page.
.. figure:: img/xiao_esp32c.jpg
:align: center
:alt: XIAO ESP32C3
XIAO ESP32C3
Hardware
********

11
boards/seeed/xiao_esp32s3/doc/index.rst
View file

@ -1,7 +1,4 @@
.. _xiao_esp32s3:
XIAO ESP32S3
############
.. zephyr:board:: xiao_esp32s3
Overview
********
@ -11,12 +8,6 @@ Espressif ESP32-S3 WiFi/Bluetooth dual-mode chip.
For more details see the `Seeed Studio XIAO ESP32S3`_ wiki page.
.. figure:: img/xiao_esp32s3.jpg
:align: center
:alt: XIAO ESP32S3
XIAO ESP32S3
Hardware
********

11
boards/seeed/xiao_rp2040/doc/index.rst
View file

@ -1,7 +1,4 @@
.. _xiao_rp2040:
XIAO RP2040
###########
.. zephyr:board:: xiao_rp2040
Overview
********
@ -13,12 +10,6 @@ to be flashed without any adapter, in a drag-and-drop manner.
For more details see the `Seeed Studio XIAO RP2040`_ wiki page.
.. figure:: img/xiao_rp2040.webp
:align: center
:alt: XIAO RP2040
XIAO RP2040
Hardware
********

8
doc/contribute/documentation/guidelines.rst
View file

@ -1201,6 +1201,14 @@ Boards
This role is used to reference a board documented using :rst:dir:`zephyr:board`.
For example::
Check out :zephyr:board:`wio_terminal` for more information.
Will render as:
Check out :zephyr:board:`wio_terminal` for more information.
.. rst:directive:: .. zephyr:board-catalog::
This directive is used to generate a catalog of Zephyr-supported boards that can be used to

2
doc/releases/release-notes-3.7.rst
View file

@ -410,7 +410,7 @@ Boards & SoC Support
* Added support for :ref:`Ambiq Apollo3 Blue board <apollo3_evb>`: ``apollo3_evb``.
* Added support for :ref:`Ambiq Apollo3 Blue Plus board <apollo3p_evb>`: ``apollo3p_evb``.
* Added support for :ref:`Raspberry Pi 5 board <rpi_5>`: ``rpi_5``.
* Added support for :ref:`Seeed Studio XIAO RP2040 board <xiao_rp2040>`: ``xiao_rp2040``.
* Added support for :zephyr:board:`Seeed Studio XIAO RP2040 board <xiao_rp2040>`: ``xiao_rp2040``.
* Added support for :ref:`Mikroe RA4M1 Clicker board <mikroe_clicker_ra4m1>`: ``mikroe_clicker_ra4m1``.
* Added support for :ref:`Arduino UNO R4 WiFi board <arduino_uno_r4>`: ``arduino_uno_r4_wifi``.
* Added support for :ref:`Renesas EK-RA8M1 board <ek_ra8m1>`: ``ek_ra8m1``.

2
samples/subsys/display/lvgl/README.rst
View file

@ -41,7 +41,7 @@ for corresponding connectors, for example:
- :ref:`adafruit_2_8_tft_touch_v2` and :ref:`nrf52840dk_nrf52840`
- :ref:`buydisplay_2_8_tft_touch_arduino` and :ref:`nrf52840dk_nrf52840`
- :ref:`ssd1306_128_shield` and :ref:`frdm_k64f`
- :ref:`seeed_xiao_round_display` and :ref:`xiao_ble`
- :ref:`seeed_xiao_round_display` and :zephyr:board:`xiao_ble`
or a board with an integrated display: