From cfd35d0c2c99c834a88dad0cff17ca5a7ea10976 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Benjamin=20Cab=C3=A9?= Date: Fri, 6 Sep 2024 11:45:03 +0200 Subject: [PATCH] samples: boards: bbc_microbit: use zephyr:code-sample directive MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Adds missing code-sample directive to all the micro:bit samples in preparation for upcoming changes to the Zephyr documentation that will be leveraging the provided description and metadata. Signed-off-by: Benjamin Cabé --- samples/boards/bbc/microbit/display/README.rst | 6 +++--- .../boards/bbc/microbit/line_follower_robot/README.rst | 6 +++--- samples/boards/bbc/microbit/pong/README.rst | 8 ++++---- samples/boards/bbc/microbit/sound/README.rst | 7 ++++--- 4 files changed, 14 insertions(+), 13 deletions(-) diff --git a/samples/boards/bbc/microbit/display/README.rst b/samples/boards/bbc/microbit/display/README.rst index ae466d0af85..4143f37752f 100644 --- a/samples/boards/bbc/microbit/display/README.rst +++ b/samples/boards/bbc/microbit/display/README.rst @@ -1,7 +1,7 @@ -.. _microbit_display: +.. zephyr:code-sample:: bbc_microbit_display + :name: LED matrix display -BBC micro:bit display -##################### + Use the 5x5 LED matrix display on the BBC micro:bit board. Overview ******** diff --git a/samples/boards/bbc/microbit/line_follower_robot/README.rst b/samples/boards/bbc/microbit/line_follower_robot/README.rst index 2d541575d48..a92d2388581 100644 --- a/samples/boards/bbc/microbit/line_follower_robot/README.rst +++ b/samples/boards/bbc/microbit/line_follower_robot/README.rst @@ -1,7 +1,7 @@ -.. _microbit_line_follower_robot: +.. zephyr:code-sample:: bbc_microbit_line_follower_robot + :name: Line following robot -BBC micro:bit line-follower robot -################################# + Implement a line following robot using a BBC micro:bit board and robot chassis. Overview ******** diff --git a/samples/boards/bbc/microbit/pong/README.rst b/samples/boards/bbc/microbit/pong/README.rst index 30be95c26b8..f5710ea7e02 100644 --- a/samples/boards/bbc/microbit/pong/README.rst +++ b/samples/boards/bbc/microbit/pong/README.rst @@ -1,12 +1,12 @@ -.. _microbit_pong: +.. zephyr:code-sample:: bbc_microbit_pong + :name: Pong game -BBC micro:bit pong game -####################### + Play pong as single player or over Bluetooth between two micro:bit devices. Overview ******** -Play pong over as single player or Bluetooth between two micro:bit +Play pong as single player or over Bluetooth between two micro:bit devices. The game works by controlling a paddle with the two buttons of the diff --git a/samples/boards/bbc/microbit/sound/README.rst b/samples/boards/bbc/microbit/sound/README.rst index 42135d44694..83984035f17 100644 --- a/samples/boards/bbc/microbit/sound/README.rst +++ b/samples/boards/bbc/microbit/sound/README.rst @@ -1,7 +1,8 @@ -.. _microbit_sound: +.. zephyr:code-sample:: bbc_microbit_sound + :name: Sound + :relevant-api: pwm_interface -BBC micro:bit sound -################### + Use the piezo buzzer on the BBC micro:bit board. Overview ********