Skip to content

Commit ccdf3ed

Browse files
committed
boards: weact: adopt new zephyr:board directive and role
This updates the documentation of all the WeAct boards to use the new `zephyr:board::` directive. Signed-off-by: Benjamin Cabé <[email protected]>
1 parent c19886c commit ccdf3ed

File tree

9 files changed

+8
-48
lines changed

9 files changed

+8
-48
lines changed

boards/weact/blackpill_f401cc/doc/index.rst

Lines changed: 1 addition & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,4 @@
1-
.. _blackpill_f401cc:
2-
3-
WeAct Studio Black Pill V1.2
4-
############################
1+
.. zephyr:board:: blackpill_f401cc
52
63
Overview
74
********
@@ -12,10 +9,6 @@ This is the 48-pin variant of the STM32F401x series,
129
see `STM32F401x reference manual`_. More info about the board available
1310
`here <stm32-base-board-page_>`_ and on `WeAct Github`_.
1411

15-
.. image:: img/blackpill-v3.jpg
16-
:align: center
17-
:alt: Black Pill V3.0+
18-
1912
Hardware
2013
********
2114

boards/weact/blackpill_f401ce/doc/index.rst

Lines changed: 1 addition & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,4 @@
1-
.. _blackpill_f401ce:
2-
3-
WeAct Studio Black Pill V3.0
4-
############################
1+
.. zephyr:board:: blackpill_f401ce
52
63
Overview
74
********
@@ -12,10 +9,6 @@ This is the 48-pin variant of the STM32F401x series,
129
see `STM32F401x reference manual`_. More info about the board available
1310
`here <stm32-base-board-page_>`_ and on `WeAct Github`_.
1411

15-
.. image:: img/blackpill-v3.jpg
16-
:align: center
17-
:alt: Black Pill V3.0+
18-
1912
Hardware
2013
********
2114

boards/weact/blackpill_f411ce/doc/index.rst

Lines changed: 1 addition & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,4 @@
1-
.. _blackpill_f411ce:
2-
3-
WeAct Studio Black Pill V2.0
4-
############################
1+
.. zephyr:board:: blackpill_f411ce
52
63
Overview
74
********
@@ -12,10 +9,6 @@ This is the 48-pin variant of the STM32F411x series,
129
see `STM32F411x reference manual`_. More info about the board available
1310
`here <stm32-base-board-page_>`_ and on `WeAct Github`_.
1411

15-
.. image:: img/blackpill-v2.jpg
16-
:align: center
17-
:alt: Black Pill V2.0+
18-
1912
Hardware
2013
********
2114

File renamed without changes.

boards/weact/mini_stm32h743/doc/index.rst

Lines changed: 1 addition & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,4 @@
1-
.. _mini_stm32h743:
2-
3-
WeAct Studio MiniSTM32H743 Core Board
4-
#####################################
1+
.. zephyr:board:: mini_stm32h743
52
63
Overview
74
********
@@ -27,12 +24,6 @@ Key Features
2724
- SWD header for external debugger
2825
- 2x 40-pin GPIO connector
2926

30-
.. figure:: img/stm32h7xx.webp
31-
:align: center
32-
:alt: MiniSTM32H743 Core Board
33-
34-
MiniSTM32H743 Core Board (Credit: WeAct Studio)
35-
3627
More information about the board can be found on the `Mini_STM32H743 website`_.
3728

3829
Hardware

boards/weact/stm32f405_core/doc/index.rst

Lines changed: 1 addition & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,4 @@
1-
.. _weact_stm32f405_core:
2-
3-
WeAct Studio STM32F405 Core Board V1.0
4-
######################################
1+
.. zephyr:board:: weact_stm32f405_core
52
63
Overview
74
********
@@ -12,10 +9,6 @@ This is the 64-pin variant of the STM32F405x series,
129
see `STM32F405x reference manual`_. More info about the board available
1310
on `WeAct Github`_.
1411

15-
.. image:: img/stm32f405_core.jpg
16-
:align: center
17-
:alt: STM32F405 Core Board v1.0
18-
1912
Hardware
2013
********
2114

boards/weact/stm32g431_core/doc/index.rst

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,4 @@
1-
.. _weact_stm32g431_core:
2-
3-
WeAct Studio STM32G431 Core Board
4-
#################################
1+
.. zephyr:board:: weact_stm32g431_core
52
63
The WeAct STM32G431 Core Board is a low-cost bare-bones STM32G431-based development
74
board. See the `STM32G431CB website`_ for more information about the MCU. More information

samples/drivers/video/capture_to_lvgl/README.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ board to receive console output messages.
2727
Building and Running
2828
********************
2929

30-
For :ref:`mini_stm32h743`, build this sample application with the following commands:
30+
For :zephyr:board:`mini_stm32h743`, build this sample application with the following commands:
3131

3232
.. zephyr-app-commands::
3333
:zephyr-app: samples/drivers/video/capture_to_lvgl/

samples/sensor/sgp40_sht4x/README.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ Building and Running
4242
This project outputs sensor data to the console. It requires a SHT4X and a SGP40
4343
sensor. It should work with any platform featuring a I2C peripheral
4444
interface. This example has an example device tree overlay
45-
for the :ref:`blackpill_f411ce` board.
45+
for the :zephyr:board:`blackpill_f411ce` board.
4646

4747

4848
.. zephyr-app-commands::

0 commit comments

Comments
 (0)