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

kartben · carlescufi · commit 702f89a49fee · 2024-10-24T17:51:15.000+02:00
This updates the documentation of all the GigaDevice boards to use
the new `zephyr:board::` directive.

Signed-off-by: Benjamin Cabé &lt;benjamin@zephyrproject.org&gt;
diff --git a/boards/gd/gd32a503v_eval/doc/index.rst b/boards/gd/gd32a503v_eval/doc/index.rst
@@ -1,8 +1,4 @@
-.. _gd32a503v_eval:
-
-GigaDevice GD32A503V-EVAL
-#########################
-
+.. zephyr:board:: gd32a503v_eval
 
 Overview
 ********
@@ -14,11 +10,6 @@ The GD32A503VD features a single-core ARM Cortex-M4F MCU which can run up
 to 120-MHz with flash accesses zero wait states, 384kiB of Flash, 48kiB of
 SRAM and 88 GPIOs.
 
-.. image:: img/gd32a503v_eval.jpg
-     :align: center
-     :alt: gd32a503v_eval
-
-
 Hardware
 ********
 
diff --git a/boards/gd/gd32e103v_eval/doc/index.rst b/boards/gd/gd32e103v_eval/doc/index.rst
@@ -1,8 +1,4 @@
-.. _gd32e103v_eval:
-
-GigaDevice GD32E103V-EVAL
-#########################
-
+.. zephyr:board:: gd32e103v_eval
 
 Overview
 ********
@@ -14,11 +10,6 @@ The GD32E103VB features a single-core ARM Cortex-M4F MCU which can run up
 to 120-MHz with flash accesses zero wait states, 128kiB of Flash, 32kiB of
 SRAM and 80 GPIOs.
 
-.. image:: img/gd32e103v_eval.jpg
-     :align: center
-     :alt: gd32e103v_eval
-
-
 Hardware
 ********
 
diff --git a/boards/gd/gd32e507v_start/doc/index.rst b/boards/gd/gd32e507v_start/doc/index.rst
@@ -1,7 +1,4 @@
-.. _gd32e507v_start:
-
-GigaDevice GD32E507V-START
-##########################
+.. zephyr:board:: gd32e507v_start
 
 Overview
 ********
@@ -13,10 +10,6 @@ The GD32E507VE features a single-core ARM Cortex-M33 MCU which can run up
 to 180 MHz with flash accesses zero wait states, 512kiB of Flash, 128kiB of
 SRAM and 80 GPIOs.
 
-.. image:: img/gd32e507v_start.jpg
-     :align: center
-     :alt: gd32e507v_start
-
 Hardware
 ********
 
diff --git a/boards/gd/gd32e507z_eval/doc/index.rst b/boards/gd/gd32e507z_eval/doc/index.rst
@@ -1,7 +1,4 @@
-.. _gd32e507z_eval:
-
-GigaDevice GD32E507Z-EVAL
-#########################
+.. zephyr:board:: gd32e507z_eval
 
 Overview
 ********
@@ -13,10 +10,6 @@ The GD32E507ZE features a single-core ARM Cortex-M33 MCU which can run up
 to 180 MHz with flash accesses zero wait states, 512kiB of Flash, 128kiB of
 SRAM and 112 GPIOs.
 
-.. image:: img/gd32e507z_eval.webp
-     :align: center
-     :alt: gd32e507z_eval
-
 Hardware
 ********
 
diff --git a/boards/gd/gd32f350r_eval/doc/index.rst b/boards/gd/gd32f350r_eval/doc/index.rst
@@ -1,7 +1,4 @@
-.. _gd32f350r_eval:
-
-GigaDevice GD32F350R-EVAL
-#########################
+.. zephyr:board:: gd32f350r_eval
 
 Overview
 ********
@@ -13,10 +10,6 @@ The GD32F350RBT6 features a single-core ARM Cortex-M4F MCU which can run up
 to 108-MHz with flash accesses zero wait states, 128kB of Flash, 16kB of
 SRAM and 55 GPIOs.
 
-.. image:: img/gd32f350r_eval.webp
-     :align: center
-     :alt: gd32f350r_eval
-
 Hardware
 ********
 
diff --git a/boards/gd/gd32f403z_eval/doc/index.rst b/boards/gd/gd32f403z_eval/doc/index.rst
@@ -1,8 +1,4 @@
-.. _gd32f403z_eval:
-
-GigaDevice GD32F403Z-EVAL
-#########################
-
+.. zephyr:board:: gd32f403z_eval
 
 Overview
 ********
@@ -14,11 +10,6 @@ The GD32F403ZE features a single-core ARM Cortex-M4F MCU which can run up
 to 168-MHz with flash accesses zero wait states, 512kiB of Flash, 96kiB of
 SRAM and 112 GPIOs.
 
-.. image:: img/gd32f403z_eval.jpg
-     :align: center
-     :alt: gd32f403z_eval
-
-
 Hardware
 ********
 
diff --git a/boards/gd/gd32f407v_start/doc/index.rst b/boards/gd/gd32f407v_start/doc/index.rst
@@ -1,7 +1,4 @@
-.. _gd32f407v_start:
-
-GigaDevice GD32F407V-START
-##########################
+.. zephyr:board:: gd32f407v_start
 
 Overview
 ********
@@ -13,10 +10,6 @@ The GD32F407VE features a single-core ARM Cortex-M4 MCU which can run up
 to 168 MHz with flash accesses zero wait states, 3072kiB of Flash, 192kiB of
 SRAM and 82 GPIOs.
 
-.. image:: img/gd32f407v_start.webp
-     :align: center
-     :alt: gd32f407v_start
-
 Hardware
 ********
 
diff --git a/boards/gd/gd32f450i_eval/doc/index.rst b/boards/gd/gd32f450i_eval/doc/index.rst
@@ -1,7 +1,4 @@
-.. _gd32f450i_eval:
-
-GigaDevice GD32F450I-EVAL
-#########################
+.. zephyr:board:: gd32f450i_eval
 
 Overview
 ********
@@ -13,11 +10,6 @@ The GD32F450IK features a single-core ARM Cortex-M4F MCU which can run up
 to 200 MHz with flash accesses zero wait states, 3072kiB of Flash, 256kiB of
 SRAM and 140 GPIOs.
 
-.. image:: img/gd32f450i_eval.webp
-     :align: center
-     :alt: gd32f450i_eval
-
-
 Hardware
 ********
 
diff --git a/boards/gd/gd32f450v_start/doc/index.rst b/boards/gd/gd32f450v_start/doc/index.rst
@@ -1,7 +1,4 @@
-.. _gd32f450v_start:
-
-GigaDevice GD32F450V-START
-##########################
+.. zephyr:board:: gd32f450v_start
 
 Overview
 ********
@@ -13,10 +10,6 @@ The GD32F450VK features a single-core ARM Cortex-M4F MCU which can run up
 to 200 MHz with flash accesses zero wait states, 3072kiB of Flash, 256kiB of
 SRAM and 82 GPIOs.
 
-.. image:: img/gd32f450v_start.webp
-     :align: center
-     :alt: gd32f450v_start
-
 Hardware
 ********
 
diff --git a/boards/gd/gd32f450z_eval/doc/index.rst b/boards/gd/gd32f450z_eval/doc/index.rst
@@ -1,7 +1,4 @@
-.. _gd32f450z_eval:
-
-GigaDevice GD32F450Z-EVAL
-#########################
+.. zephyr:board:: gd32f450z_eval
 
 Overview
 ********
@@ -13,11 +10,6 @@ The GD32F450ZK features a single-core ARM Cortex-M4F MCU which can run up
 to 200 MHz with flash accesses zero wait states, 3072kiB of Flash, 256kiB of
 SRAM and 114 GPIOs.
 
-.. image:: img/gd32f450z_eval.webp
-     :align: center
-     :alt: gd32f450z_eval
-
-
 Hardware
 ********
 
diff --git a/boards/gd/gd32f470i_eval/doc/index.rst b/boards/gd/gd32f470i_eval/doc/index.rst
@@ -1,7 +1,4 @@
-.. _gd32f470i_eval:
-
-GigaDevice GD32F470I-EVAL
-#########################
+.. zephyr:board:: gd32f470i_eval
 
 Overview
 ********
@@ -13,11 +10,6 @@ The GD32F470IK features a single-core ARM Cortex-M4F MCU which can run up
 to 240 MHz with flash accesses zero wait states, 3072kiB of Flash, 256kiB of
 SRAM and 140 GPIOs.
 
-.. image:: img/gd32f470i_eval.jpg
-     :align: center
-     :alt: gd32f470i_eval
-
-
 Hardware
 ********
 
diff --git a/boards/gd/gd32l233r_eval/doc/index.rst b/boards/gd/gd32l233r_eval/doc/index.rst
@@ -1,7 +1,4 @@
-.. _gd32l233r_eval:
-
-GigaDevice GD32L233R-EVA
-#########################
+.. zephyr:board:: gd32l233r_eval
 
 Overview
 ********
@@ -13,10 +10,6 @@ The GD32RCT6 features a single-core ARM Cortex-M4F MCU which can run up
 to 64-MHz with flash accesses zero wait states, 256kB of Flash, 32kB of
 SRAM and 59 GPIOs.
 
-.. image:: img/gd32l233r_eval.jpg
-     :align: center
-     :alt: gd32l233r_eval
-
 Hardware
 ********
 
diff --git a/boards/gd/gd32vf103c_starter/doc/index.rst b/boards/gd/gd32vf103c_starter/doc/index.rst
@@ -1,7 +1,4 @@
-.. _gd32vf103c_starter:
-
-GigaDevice GD32VF103C-STARTER
-#############################
+.. zephyr:board:: gd32vf103c_starter
 
 Overview
 ********
@@ -13,10 +10,6 @@ The GD32VF103CB features a single-core RISC-V 32-bit MCU which can run up
 to 108 MHz with flash accesses zero wait states, 128 KiB of Flash, 32 KiB of
 SRAM and 37 GPIOs.
 
-.. image:: img/gd32vf103c_starter.jpg
-     :align: center
-     :alt: gd32vf103c_starter
-
 Hardware
 ********
 
diff --git a/boards/gd/gd32vf103v_eval/doc/index.rst b/boards/gd/gd32vf103v_eval/doc/index.rst
@@ -1,7 +1,4 @@
-.. _gd32vf103v_eval:
-
-GigaDevice GD32VF103V-EVAL
-##########################
+.. zephyr:board:: gd32vf103v_eval
 
 Overview
 ********
@@ -13,10 +10,6 @@ The GD32VF103VB features a single-core RISC-V 32-bit MCU which can run up
 to 108 MHz with flash accesses zero wait states, 128 KiB of Flash, 32 KiB of
 SRAM and 80 GPIOs.
 
-.. image:: img/gd32vf103v_eval.jpg
-     :align: center
-     :alt: gd32vf103v_eval
-
 Hardware
 ********
 
diff --git a/samples/drivers/dac/README.rst b/samples/drivers/dac/README.rst
@@ -180,7 +180,7 @@ DAC output is available on pin 1 of the MCP4725.
 Building and Running for GD32450I-EVAL
 ======================================
 The sample can be built and executed for the
-:ref:`gd32f450i_eval` as follows:
+:zephyr:board:`gd32f450i_eval` as follows:
 
 .. zephyr-app-commands::
    :zephyr-app: samples/drivers/dac
diff --git a/samples/drivers/eeprom/README.rst b/samples/drivers/eeprom/README.rst
@@ -35,7 +35,7 @@ as follows:
    :shield: x_nucleo_eeprma2
    :compact:
 
-For :ref:`gd32f450i_eval` board. First bridge the JP5 to USART with the jumper cap,
+For :zephyr:board:`gd32f450i_eval` board. First bridge the JP5 to USART with the jumper cap,
 Then the sample can be built and executed for the  as follows:
 
 .. zephyr-app-commands::
