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

This updates the documentation of all the Espressif boards to use the new `zephyr:board::` directive. Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
ycsin · Oct 24, 2024 · f0ec6ad · f0ec6ad
1 parent 1aa45f7
commit f0ec6ad
Show file tree

Hide file tree

Showing 19 changed files with 24 additions and 89 deletions.
diff --git a/boards/espressif/esp32_devkitc_wroom/doc/index.rst b/boards/espressif/esp32_devkitc_wroom/doc/index.rst
@@ -1,7 +1,4 @@
-.. _esp32_devkitc_wroom:
-
-ESP32-DevKitC-WROOM
-###################
+.. zephyr:board:: esp32_devkitc_wroom
 
 Overview
 ********
@@ -41,12 +38,6 @@ The features include the following:
 - Cryptographic hardware acceleration (RNG, ECC, RSA, SHA-2, AES)
 - 5uA deep sleep current
 
-.. figure:: img/esp32_devkitc_wroom.jpg
-    :align: center
-    :alt: ESP32-DevKitC-WROOM
-
-    ESP32-DevKitC-WROOM-32D DK
-
 For more information, check the datasheet at `ESP32 Datasheet`_ or the technical reference
 manual at `ESP32 Technical Reference Manual`_.
 

diff --git a/boards/espressif/esp32_devkitc_wrover/doc/index.rst b/boards/espressif/esp32_devkitc_wrover/doc/index.rst
@@ -1,7 +1,4 @@
-.. _esp32_devkitc_wrover:
-
-ESP32-DevKitC-WROVER
-####################
+.. zephyr:board:: esp32_devkitc_wrover
 
 Overview
 ********
@@ -41,12 +38,6 @@ The features include the following:
 - Cryptographic hardware acceleration (RNG, ECC, RSA, SHA-2, AES)
 - 5uA deep sleep current
 
-.. figure:: img/esp32_devkitc_wrover.jpg
-    :align: center
-    :alt: ESP32-DevKitC-WROVER
-
-    ESP32-DevKitC-WROVER-IE
-
 For more information, check the datasheet at `ESP32 Datasheet`_ or the technical reference
 manual at `ESP32 Technical Reference Manual`_.
 

diff --git a/boards/espressif/esp32_ethernet_kit/doc/index.rst b/boards/espressif/esp32_ethernet_kit/doc/index.rst
@@ -1,7 +1,4 @@
-.. _esp32_ethernet_kit:
-
-ESP32-Ethernet-Kit
-##################
+.. zephyr:board:: esp32_ethernet_kit
 
 Overview
 ********
@@ -13,13 +10,6 @@ over Ethernet (PoE).
 
 .. _get-started-esp32-ethernet-kit-v1.2-overview:
 
-.. figure:: img/esp32_ethernet_kit.jpg
-    :align: center
-    :alt: ESP32-Ethernet-Kit V1.2
-    :figclass: align-center
-
-    ESP32-Ethernet-Kit V1.2 Overview
-
 ESP32-Ethernet-Kit is an ESP32-WROVER-E based development.
 For more information, check the datasheet at `ESP32-WROVER-E Datasheet`_.
 

diff --git a/boards/espressif/esp32c3_devkitc/doc/index.rst b/boards/espressif/esp32c3_devkitc/doc/index.rst
@@ -1,7 +1,4 @@
-.. _esp32c3_devkitc:
-
-ESP32-C3-DevKitC
-################
+.. zephyr:board:: esp32c3_devkitc
 
 Overview
 ********

diff --git a/boards/espressif/esp32c3_devkitm/doc/index.rst b/boards/espressif/esp32c3_devkitm/doc/index.rst
@@ -1,7 +1,4 @@
-.. _esp32c3_devkitm:
-
-ESP32-C3-DevKitM
-################
+.. zephyr:board:: esp32c3_devkitm
 
 Overview
 ********

diff --git a/boards/espressif/esp32c3_rust/doc/index.rst b/boards/espressif/esp32c3_rust/doc/index.rst
@@ -1,7 +1,4 @@
-.. _esp32c3_rust:
-
-ESP32-C3-DevKit-RUST
-####################
+.. zephyr:board:: esp32c3_rust
 
 Overview
 ********

diff --git a/boards/espressif/esp32c6_devkitc/doc/index.rst b/boards/espressif/esp32c6_devkitc/doc/index.rst
@@ -1,7 +1,4 @@
-.. _esp32c6_devkitc:
-
-ESP32-C6-DevKitC
-################
+.. zephyr:board:: esp32c6_devkitc
 
 Overview
 ********

diff --git a/boards/espressif/esp32s2_devkitc/doc/index.rst b/boards/espressif/esp32s2_devkitc/doc/index.rst
@@ -1,7 +1,4 @@
-.. _esp32s2_devkitc:
-
-ESP32-S2-DevKitC
-################
+.. zephyr:board:: esp32s2_devkitc
 
 Overview
 ********
@@ -254,7 +251,7 @@ References
 
 .. target-notes::
 
-.. _`ESP32-S3-DevKitC`: https://docs.espressif.com/projects/esp-idf/en/latest/esp32s2/hw-reference/esp32s2/user-guide-saola-1-v1.2.html
+.. _`ESP32-S2-DevKitC`: https://docs.espressif.com/projects/esp-idf/en/latest/esp32s2/hw-reference/esp32s2/user-guide-saola-1-v1.2.html
 .. _`ESP32-S2 Datasheet`: https://www.espressif.com/sites/default/files/documentation/esp32-s2_datasheet_en.pdf
 .. _`ESP32-S2 Technical Reference Manual`: https://espressif.com/sites/default/files/documentation/esp32-s2_technical_reference_manual_en.pdf
 .. _`JTAG debugging for ESP32-S2`: https://docs.espressif.com/projects/esp-idf/en/latest/esp32s2/api-guides/jtag-debugging/index.html

diff --git a/boards/espressif/esp32s2_saola/doc/index.rst b/boards/espressif/esp32s2_saola/doc/index.rst
@@ -1,7 +1,4 @@
-.. _esp32s2_saola:
-
-ESP32-S2-Saola
-##############
+.. zephyr:board:: esp32s2_saola
 
 Overview
 ********

diff --git a/boards/espressif/esp32s3_devkitc/doc/index.rst b/boards/espressif/esp32s3_devkitc/doc/index.rst
@@ -1,7 +1,4 @@
-.. _esp32s3_devkitc:
-
-ESP32-S3-DevKitC
-################
+.. zephyr:board:: esp32s3_devkitc
 
 Overview
 ********

diff --git a/boards/espressif/esp32s3_devkitm/doc/index.rst b/boards/espressif/esp32s3_devkitm/doc/index.rst
@@ -1,7 +1,4 @@
-.. _esp32s3_devkitm:
-
-ESP32-S3-DevKitM
-################
+.. zephyr:board:: esp32s3_devkitm
 
 Overview
 ********

diff --git a/boards/espressif/esp32s3_eye/doc/index.rst b/boards/espressif/esp32s3_eye/doc/index.rst
@@ -1,7 +1,4 @@
-.. _esp32s3_eye:
-
-ESP32-S3-EYE
-############
+.. zephyr:board:: esp32s3_eye
 
 Overview
 ********
@@ -20,10 +17,6 @@ ESP32-S3-WROOM-1 module, camera, SD card slot, digital microphone, USB port, and
 and the sub board (ESP32-S3-EYE-SUB) that contains an LCD display.
 The main board and sub board are connected through pin headers.
 
-.. figure:: img/ESP32-S3-EYE-isometric.webp
-    :align: center
-    :alt: ESP32-S3-EYE
-
 Block Diagram
 -------------
 

diff --git a/boards/espressif/esp8684_devkitm/doc/index.rst b/boards/espressif/esp8684_devkitm/doc/index.rst
@@ -1,7 +1,4 @@
-.. _esp8684_devkitm:
-
-ESP8684-DevKitM
-###############
+.. zephyr:board:: esp8684_devkitm
 
 Overview
 ********

diff --git a/boards/espressif/esp_wrover_kit/doc/index.rst b/boards/espressif/esp_wrover_kit/doc/index.rst
@@ -1,7 +1,4 @@
-.. _esp_wrover_kit:
-
-ESP-WROVER-KIT
-##############
+.. zephyr:board:: esp_wrover_kit
 
 Overview
 ********

diff --git a/doc/releases/release-notes-3.7.rst b/doc/releases/release-notes-3.7.rst
@@ -432,9 +432,9 @@ Boards & SoC Support
   * Added support for :zephyr:board:`Analog Devices AD-APARD32690-SL <apard32690>`: ``ad_apard32690_sl``.
   * Added support for :ref:`Infineon Technologies CYW920829M2EVK-02 <cyw920829m2evk_02>`: ``cyw920829m2evk_02``.
   * Added support for :ref:`Nuvoton Numaker M2L31KI board <nuvoton_m2l31ki>`: ``numaker_m2l31ki``.
-  * Added support for :ref:`Espressif ESP32-S2 DevKit-C <esp32s2_devkitc>`: ``esp32s2_devkitc``.
-  * Added support for :ref:`Espressif ESP32-S3 DevKit-C <esp32s3_devkitc>`: ``esp32s3_devkitc``.
-  * Added support for :ref:`Espressif ESP32-C6 DevKit-C <esp32c6_devkitc>`: ``esp32c6_devkitc``.
+  * Added support for :zephyr:board:`Espressif ESP32-S2 DevKit-C <esp32s2_devkitc>`: ``esp32s2_devkitc``.
+  * Added support for :zephyr:board:`Espressif ESP32-S3 DevKit-C <esp32s3_devkitc>`: ``esp32s3_devkitc``.
+  * Added support for :zephyr:board:`Espressif ESP32-C6 DevKit-C <esp32c6_devkitc>`: ``esp32c6_devkitc``.
   * Added support for :ref:`Waveshare ESP32-S3-Touch-LCD-1.28 <esp32s3_touch_lcd_1_28>`: ``esp32s3_touch_lcd_1_28``.
   * Added support for :ref:`M5Stack ATOM Lite <m5stack_atom_lite>`: ``m5stack_atom_lite``.
   * Added support for :ref:`CTHINGS.CO Connectivity Card nRF52840 <ctcc_nrf52840>`: ``ctcc_nrf52840``.

diff --git a/samples/basic/blinky_pwm/README.rst b/samples/basic/blinky_pwm/README.rst
@@ -53,11 +53,11 @@ In these other cases, however, manual wiring is necessary:
      - connect PWM1 (PA8) to an LED
    * - :ref:`nucleo_wb55rg_board`
      - connect PWM1 (PA8) to an LED
-   * - :ref:`esp32_devkitc_wroom`
+   * - :zephyr:board:`esp32_devkitc_wroom`
      - connect GPIO2 to an LED
-   * - :ref:`esp32s2_saola`
+   * - :zephyr:board:`esp32s2_saola`
      - connect GPIO2 to an LED
-   * - :ref:`esp32c3_devkitm`
+   * - :zephyr:board:`esp32c3_devkitm`
      - connect GPIO2 to an LED
 
 Building and Running

diff --git a/samples/boards/espressif/deep_sleep/README.rst b/samples/boards/espressif/deep_sleep/README.rst
@@ -31,7 +31,7 @@ Requirements
 ************
 
 This example should be able to run on any commonly available
-:ref:`esp32_devkitc_wroom` development board without any extra hardware if
+:zephyr:board:`esp32_devkitc_wroom` development board without any extra hardware if
 only ``Timer`` is used as wakeup source.
 
 However, when ``EXT1`` is also enabled, GPIO2 and GPIO4 should be pulled-down

diff --git a/samples/boards/espressif/wifi_apsta_mode/README.rst b/samples/boards/espressif/wifi_apsta_mode/README.rst
@@ -28,7 +28,7 @@ Requirements
 ************
 
 This example should be able to run on any commonly available
-:ref:`esp32_devkitc_wroom` development board without any extra hardware.
+:zephyr:board:`esp32_devkitc_wroom` development board without any extra hardware.
 
 To enable or disable ``AP-STA`` mode, modify the :kconfig:option:`CONFIG_ESP32_WIFI_AP_STA_MODE`
 parameter in the ``boards/esp32_devkitc_wroom_procpu.conf`` file of the demo. Moreover, an

diff --git a/samples/subsys/display/lvgl/README.rst b/samples/subsys/display/lvgl/README.rst
@@ -45,7 +45,7 @@ for corresponding connectors, for example:
 
 or a board with an integrated display:
 
-- :ref:`esp_wrover_kit`
+- :zephyr:board:`esp_wrover_kit`
 
 or a simulated display environment in a :ref:`native_sim <native_sim>` application: