From aaccb6323f955aa2ed422b174b22d2a9d3e685d6 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Benjamin=20Cab=C3=A9?= Date: Fri, 18 Oct 2024 12:38:17 +0200 Subject: [PATCH] boards: bbc: adopt new zephyr:board directive and role MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit This updates the documentation of all the BBC boards to use the new `zephyr:board::` directive. Signed-off-by: Benjamin Cabé --- boards/bbc/microbit/doc/index.rst | 11 +---------- boards/bbc/microbit_v2/doc/index.rst | 11 +---------- samples/basic/servo_motor/README.rst | 2 +- samples/boards/nordic/nrf_led_matrix/README.rst | 2 +- samples/sensor/fxos8700/README.rst | 2 +- 5 files changed, 5 insertions(+), 23 deletions(-) diff --git a/boards/bbc/microbit/doc/index.rst b/boards/bbc/microbit/doc/index.rst index c4d11f7a671..1d829d89a89 100644 --- a/boards/bbc/microbit/doc/index.rst +++ b/boards/bbc/microbit/doc/index.rst @@ -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 diff --git a/boards/bbc/microbit_v2/doc/index.rst b/boards/bbc/microbit_v2/doc/index.rst index d906f13660b..62c3cee2252 100644 --- a/boards/bbc/microbit_v2/doc/index.rst +++ b/boards/bbc/microbit_v2/doc/index.rst @@ -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 diff --git a/samples/basic/servo_motor/README.rst b/samples/basic/servo_motor/README.rst index e4f2e494196..4726a7ad188 100644 --- a/samples/basic/servo_motor/README.rst +++ b/samples/basic/servo_motor/README.rst @@ -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: diff --git a/samples/boards/nordic/nrf_led_matrix/README.rst b/samples/boards/nordic/nrf_led_matrix/README.rst index f7a0c829cb9..9cf33b6d13c 100644 --- a/samples/boards/nordic/nrf_led_matrix/README.rst +++ b/samples/boards/nordic/nrf_led_matrix/README.rst @@ -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 ************ diff --git a/samples/sensor/fxos8700/README.rst b/samples/sensor/fxos8700/README.rst index 505952cec6a..52b8a96a33e 100644 --- a/samples/sensor/fxos8700/README.rst +++ b/samples/sensor/fxos8700/README.rst @@ -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