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

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

Browse source 
This updates the documentation of all the Adafruit 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-18 17:12:09 +02:00 committed by Carles Cufí
parent 77a35d835a
commit 599e0625e3
13 changed files with 13 additions and 97 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

9
boards/adafruit/feather_m0_basic_proto/doc/index.rst
View file

@ -1,7 +1,4 @@
.. _adafruit_feather_m0_basic_proto:
Adafruit Feather M0 Basic Proto
###############################
.. zephyr:board:: adafruit_feather_m0_basic_proto
Overview
********
@ -11,10 +8,6 @@ board with an onboard battery connector and charger for 3.7 V lithium
polymer batteries, charging status indicator and user LEDs, native USB
connector, 20 I/O pins, and a small prototyping area.
.. image:: img/adafruit_feather_m0_basic_proto.jpg
:align: center
:alt: Adafruit Feather M0 Basic Proto
Hardware
********

9
boards/adafruit/feather_m0_lora/doc/index.rst
View file

@ -1,7 +1,4 @@
.. _adafruit_feather_m0_lora:
Adafruit Feather M0 LoRa
########################
.. zephyr:board:: adafruit_feather_m0_lora
Overview
********
@ -11,10 +8,6 @@ boards with an onboard battery connector and charger for 3.7 V lithium
polymer batteries, charging status indicator and user LEDs, native USB
connector, 20 I/O pins, and a LoRa radio module from Semtech.
.. image:: img/adafruit_feather_m0_lora.jpg
:align: center
:alt: Adafruit Feather M0 LoRa
Hardware
********

5
boards/adafruit/feather_nrf52840/doc/index.rst
View file

@ -1,7 +1,4 @@
.. _adafruit_feather_nrf52840:
Adafruit Feather nRF52840 (Express, Sense)
##########################################
.. zephyr:board:: adafruit_feather_nrf52840
Overview
********

9
boards/adafruit/feather_stm32f405/doc/index.rst
View file

@ -1,7 +1,4 @@
.. _adafruit_feather_stm32f405:
Adafruit Feather STM32F405 Express
##################################
.. zephyr:board:: adafruit_feather_stm32f405
Overview
********
@ -12,10 +9,6 @@ devices labeled as Feathers or FeatherWings. The board is equipped
with a lithium ion battery charger, native USB C connector, 2MB of
external flash memory, and SD card socket.
.. image:: img/adafruit_feather_stm32f405.jpg
:align: center
:alt: Adafruit Feather STM32F405 Express
Hardware
********

12
boards/adafruit/grand_central_m4_express/doc/index.rst
View file

@ -1,7 +1,4 @@
.. _adafruit_grand_central_m4_express:
Adafruit Grand Central M4 Express
#################################
.. zephyr:board:: adafruit_grand_central_m4_express
Overview
********
@ -10,13 +7,6 @@ The Adafruit Grand Central M4 Express is an ARM development board with the
form factor of an Arduino Mega.
It features 70 GPIO pins, a microSDHC slot and 8MiB of QSPI Flash.
.. figure:: img/adafruit_grand_central_m4_express.webp
:width: 800px
:align: center
:alt: Adafruit Grand Central M4 Express
Adafruit Grand Central M4 Express (Credit: Kattni Rembor / Adafruit)
Hardware
********

9
boards/adafruit/itsybitsy/doc/index.rst
View file

@ -1,7 +1,4 @@
.. _adafruit_itsybitsy_nrf52840:
Adafruit ItsyBitsy nRF52840
###########################
.. zephyr:board:: adafruit_itsybitsy
Overview
********
@ -29,10 +26,6 @@ This development kit has the following features:
* :abbr:`USB (Universal Serial Bus)`
* :abbr:`WDT (Watchdog Timer)`
.. image:: img/adafruit_itsybitsy_nrf52840.jpeg
:align: center
:alt: Adafruit ItsyBitsy nRF52840 Express
Hardware
********
- nRF52840 ARM Cortex-M4F CPU at 64MHz

9
boards/adafruit/itsybitsy_m4_express/doc/index.rst
View file

@ -1,7 +1,4 @@
.. _adafruit_itsybitsy_m4_express:
Adafruit ItsyBitsy M4 Express
#############################
.. zephyr:board:: adafruit_itsybitsy_m4_express
Overview
********
@ -10,10 +7,6 @@ The Adafruit ItsyBitsy M4 express is a small (36 mm x 18 mm) ARM development
board with an onboard RGB LED, USB port, 2 MiB of SPI flash, and range of I/O
broken out onto 23 GPIO pins.
.. image:: img/adafruit_itsybitsy_m4_express.jpg
:align: center
:alt: Adafruit ItsyBitsy M4 Express
Hardware
********

12
boards/adafruit/kb2040/doc/index.rst
View file

@ -1,7 +1,4 @@
.. _adafruit_kb2040:
Adafruit KB2040
###############
.. zephyr:board:: adafruit_kb2040
Overview
********
@ -27,13 +24,6 @@ Hardware
- On-board RGB LED
- 1 Watchdog timer peripheral
.. figure:: img/kb2040.jpg
:align: center
:alt: Adafruit KB2040
Adafruit KB2040 (Image courtesy of Adafruit)
Supported Features
==================

11
boards/adafruit/nrf52_adafruit_feather/doc/index.rst
View file

@ -1,7 +1,4 @@
.. _nrf52_adafruit_feather:
nRF52 Adafruit Feather
######################
.. zephyr:board:: nrf52_adafruit_feather
Overview
********
@ -18,12 +15,6 @@ the following devices:
* RADIO (Bluetooth Low Energy)
* Segger RTT (RTT Console)
.. figure:: img/nrf52_adafruit_feather.jpg
:align: center
:alt: nRF52 Adafruit Feather Board
nRF52 Adafruit Feather Board (Credit: Adafruit)
More information about the board and its features can be found at the
`Adafruit Feather nRF52 Bluefruit Learning Guide`_. The `Nordic Semiconductor Infocenter`_
contains the processor's information and the datasheet.

12
boards/adafruit/qt_py_rp2040/doc/index.rst
View file

@ -1,7 +1,4 @@
.. _adafruit_qt_py_rp2040:
Adafruit QT Py RP2040
#####################
.. zephyr:board:: adafruit_qt_py_rp2040
Overview
********
@ -27,13 +24,6 @@ Hardware
- On-board RGB LED
- 1 Watchdog timer peripheral
.. figure:: img/qtpy_rp2040.jpg
:align: center
:alt: Adafruit QT Py RP2040
Adafruit QT Py RP2040 (Image courtesy of Adafruit)
Supported Features
==================

9
boards/adafruit/trinket_m0/doc/index.rst
View file

@ -1,7 +1,4 @@
.. _adafruit_trinket_m0:
Adafruit Trinket M0
###################
.. zephyr:board:: adafruit_trinket_m0
Overview
********
@ -10,10 +7,6 @@ The Adafruit Trinket M0 is a tiny (27 mm x 15 mm) ARM development
board with an onboard RGB LED, USB port, and range of I/O broken out
onto 5 pins.
.. image:: img/adafruit_trinket_m0.jpg
:align: center
:alt: Adafruit Trinket M0
Hardware
********

2
doc/develop/flash_debug/host-tools.rst
View file

@ -177,7 +177,7 @@ More implementation details can be found in the :ref:`boards` documentation.
As a quick reference, see these three board documentation pages:
- :ref:`sam4e_xpro` (ROM bootloader)
- :ref:`adafruit_feather_m0_basic_proto` (Adafruit UF2 bootloader)
- :zephyr:board:`adafruit_feather_m0_basic_proto` (Adafruit UF2 bootloader)
- :ref:`arduino_nano_33_iot` (Arduino bootloader)
- :ref:`arduino_nano_33_ble` (Arduino legacy bootloader)

2
samples/sensor/bme280/README.rst
View file

@ -112,7 +112,7 @@ See existing overlays for examples.
The build system uses these overlays by default when targeting those boards, so
no ``DTC_OVERLAY_FILE`` setting is needed when building and running.
For example, to build for the :ref:`adafruit_feather_m0_basic_proto` using the
For example, to build for the :zephyr:board:`adafruit_feather_m0_basic_proto` using the
:zephyr_file:`samples/sensor/bme280/boards/adafruit_feather_m0_basic_proto.overlay`
overlay provided with this sample: