Browse Source

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>
pull/80294/head
Benjamin Cabé 9 months ago committed by Carles Cufí
parent
commit
aaccb6323f
  1. 11
      boards/bbc/microbit/doc/index.rst
  2. 11
      boards/bbc/microbit_v2/doc/index.rst
  3. 2
      samples/basic/servo_motor/README.rst
  4. 2
      samples/boards/nordic/nrf_led_matrix/README.rst
  5. 2
      samples/sensor/fxos8700/README.rst

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

@ -1,7 +1,4 @@
.. _bbc_microbit: .. zephyr:board:: bbc_microbit
BBC MicroBit
##############
Overview Overview
******** ********
@ -23,12 +20,6 @@ connectors that are part of the 23-pin edge connector.
* FLASH * FLASH
* RADIO (Bluetooth Low Energy) * 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`_. More information about the board can be found at the `microbit website`_.
Hardware Hardware

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

@ -1,7 +1,4 @@
.. _bbc_microbit_v2: .. zephyr:board:: bbc_microbit_v2
BBC MicroBit V2
#################
Overview 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 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. 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`_. More information about the board can be found at the `microbit website`_.
Hardware Hardware

2
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 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 This sample can be built for multiple boards, in this example we will build it
for the bbc_microbit board: for the bbc_microbit board:

2
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 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 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 Requirements
************ ************

2
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`, sensor is present on the :ref:`frdm_k64f`, :ref:`frdm_k22f`,
:ref:`frdm_kw41z`, :ref:`hexiwear`, and :ref:`twr_ke18f` boards. :ref:`frdm_kw41z`, :ref:`hexiwear`, and :ref:`twr_ke18f` boards.
Accelerometer only devices are present on the :ref:`frdm_kl25z`, 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. QEMU.
Building and Running for FRDM-K64F Building and Running for FRDM-K64F

Loading…
Cancel
Save