OrgZephyr/zephyr
OrgZephyr
/
zephyr
mirror of https://github.com/zephyrproject-rtos/zephyr.git
1
0
Fork 0
Code Issues Releases Wiki Activity

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

This updates the documentation of all the BBC 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 12:38:17 +02:00 committed by Carles Cufí
parent 233d264e53
commit aaccb6323f
5 changed files with 5 additions and 23 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
boards/bbc/microbit/doc/index.rst
View File

@ -1,7 +1,4 @@
.. _bbc_microbit:
BBC MicroBit
##############
.. zephyr:board:: bbc_microbit
Overview
********
@ -23,12 +20,6 @@ connectors that are part of the 23-pin edge connector.
* FLASH
* RADIO (Bluetooth Low Energy)
.. figure:: img/bbc_microbit.jpg
:align: center
:alt: BBC Micro Bit
BBC Micro Bit (Credit: http://microbit.org/)
More information about the board can be found at the `microbit website`_.
Hardware

11
boards/bbc/microbit_v2/doc/index.rst
View File

@ -1,7 +1,4 @@
.. _bbc_microbit_v2:
BBC MicroBit V2
#################
.. zephyr:board:: bbc_microbit_v2
Overview
********
@ -16,12 +13,6 @@ magnetometer sensors, Bluetooth and USB connectivity, a display consisting of
USB or an external battery pack. The device inputs and outputs are through five
ring connectors that are part of the 23-pin edge connector.
.. figure:: img/bbc_microbit2.jpg
:align: center
:alt: BBC Micro Bit V2
BBC Micro Bit V2 (Credit: http://microbit.org/)
More information about the board can be found at the `microbit website`_.
Hardware

2
samples/basic/servo_motor/README.rst
View File

@ -52,7 +52,7 @@ ground and the white wire to the SCL pin, i.e. pin P19 on the edge connector.
Building and Running
********************
The sample has a devicetree overlay for the :ref:`bbc_microbit`.
The sample has a devicetree overlay for the :zephyr:board:`bbc_microbit`.
This sample can be built for multiple boards, in this example we will build it
for the bbc_microbit board:

2
samples/boards/nordic/nrf_led_matrix/README.rst
View File

@ -8,7 +8,7 @@ Overview
This is a simple application intended to present the nRF LED matrix display
driver in action and to serve as a test ensuring that this driver is buildable
for both the :ref:`bbc_microbit_v2` and :ref:`bbc_microbit` boards.
for both the :zephyr:board:`bbc_microbit_v2` and :zephyr:board:`bbc_microbit` boards.
Requirements
************

2
samples/sensor/fxos8700/README.rst
View File

@ -18,7 +18,7 @@ This project outputs sensor data to the console. FXOS8700
sensor is present on the :ref:`frdm_k64f`, :ref:`frdm_k22f`,
:ref:`frdm_kw41z`, :ref:`hexiwear`, and :ref:`twr_ke18f` boards.
Accelerometer only devices are present on the :ref:`frdm_kl25z`,
:ref:`bbc_microbit`, and :ref:`reel_board` boards. It does not work on
:zephyr:board:`bbc_microbit`, and :ref:`reel_board` boards. It does not work on
QEMU.
Building and Running for FRDM-K64F