From a17d854004cf8ffb41124fe6ffb858aea46e0fa7 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Benjamin=20Cab=C3=A9?= Date: Fri, 18 Oct 2024 15:10:35 +0200 Subject: [PATCH] boards: nuvoton: adopt new zephyr:board directive and role MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit This updates the documentation of all the Nuvoton boards to use the new `zephyr:board::` directive. Signed-off-by: Benjamin Cabé --- boards/nuvoton/npcm400_evb/doc/index.rst | 9 +-------- boards/nuvoton/npcx4m8f_evb/doc/index.rst | 9 +-------- boards/nuvoton/npcx7m6fb_evb/doc/index.rst | 9 +-------- boards/nuvoton/npcx9m6f_evb/doc/index.rst | 9 +-------- boards/nuvoton/numaker_m2l31ki/doc/index.rst | 9 +-------- boards/nuvoton/numaker_pfm_m467/doc/index.rst | 10 +--------- boards/nuvoton/numaker_pfm_m487/doc/index.rst | 9 +-------- doc/releases/release-notes-3.7.rst | 2 +- samples/sensor/adc_cmp_npcx/README.rst | 4 ++-- 9 files changed, 10 insertions(+), 60 deletions(-) diff --git a/boards/nuvoton/npcm400_evb/doc/index.rst b/boards/nuvoton/npcm400_evb/doc/index.rst index d5d9ee550c2..93c91eb474a 100644 --- a/boards/nuvoton/npcm400_evb/doc/index.rst +++ b/boards/nuvoton/npcm400_evb/doc/index.rst @@ -1,7 +1,4 @@ -.. _npcm400_evb: - -Nuvoton NPCM400_EVB -#################### +.. zephyr:board:: npcm400_evb Overview ******** @@ -10,10 +7,6 @@ The NPCM400_EVB kit is a development platform to evaluate the Nuvoton NPCM4 series microcontrollers. This board needs to be mated with part number NPCM400 Satellite Management Controller (SMC). -.. image:: npcm400_evb.webp - :align: center - :alt: NPCM400 Evaluation Board - Hardware ******** diff --git a/boards/nuvoton/npcx4m8f_evb/doc/index.rst b/boards/nuvoton/npcx4m8f_evb/doc/index.rst index 928c4f2ce81..1fd1e7ae5d9 100644 --- a/boards/nuvoton/npcx4m8f_evb/doc/index.rst +++ b/boards/nuvoton/npcx4m8f_evb/doc/index.rst @@ -1,7 +1,4 @@ -.. _npcx4m8f_evb: - -Nuvoton NPCX4M8F_EVB -#################### +.. zephyr:board:: npcx4m8f_evb Overview ******** @@ -10,10 +7,6 @@ The NPCX4M8F_EVB kit is a development platform to evaluate the Nuvoton NPCX4 series microcontrollers. This board needs to be mated with part number NPCX498F. -.. image:: npcx4m8f_evb.jpg - :align: center - :alt: NPCX4M8F Evaluation Board - Hardware ******** diff --git a/boards/nuvoton/npcx7m6fb_evb/doc/index.rst b/boards/nuvoton/npcx7m6fb_evb/doc/index.rst index 3bcf013f84f..2dc8382d737 100644 --- a/boards/nuvoton/npcx7m6fb_evb/doc/index.rst +++ b/boards/nuvoton/npcx7m6fb_evb/doc/index.rst @@ -1,7 +1,4 @@ -.. _npcx7m6fb_evb: - -Nuvoton NPCX7M6FB_EVB -##################### +.. zephyr:board:: npcx7m6fb_evb Overview ******** @@ -10,10 +7,6 @@ The NPCX7M6FB_EVB kit is a development platform to evaluate the Nuvoton NPCX7 series microcontrollers. This board needs to be mated with part number NPCX796FB. -.. image:: npcx7m6fb_evb.jpg - :align: center - :alt: NPCX7M6FB Evaluation Board - Hardware ******** diff --git a/boards/nuvoton/npcx9m6f_evb/doc/index.rst b/boards/nuvoton/npcx9m6f_evb/doc/index.rst index e9ed19970c5..2e9ac2e368b 100644 --- a/boards/nuvoton/npcx9m6f_evb/doc/index.rst +++ b/boards/nuvoton/npcx9m6f_evb/doc/index.rst @@ -1,7 +1,4 @@ -.. _npcx9m6f_evb: - -Nuvoton NPCX9M6F_EVB -#################### +.. zephyr:board:: npcx9m6f_evb Overview ******** @@ -10,10 +7,6 @@ The NPCX9M6F_EVB kit is a development platform to evaluate the Nuvoton NPCX9 series microcontrollers. This board needs to be mated with part number NPCX996F. -.. image:: npcx9m6f_evb.jpg - :align: center - :alt: NPCX9M6F Evaluation Board - Hardware ******** diff --git a/boards/nuvoton/numaker_m2l31ki/doc/index.rst b/boards/nuvoton/numaker_m2l31ki/doc/index.rst index 031deb73b67..98838ae7e1d 100644 --- a/boards/nuvoton/numaker_m2l31ki/doc/index.rst +++ b/boards/nuvoton/numaker_m2l31ki/doc/index.rst @@ -1,7 +1,4 @@ -.. _nuvoton_m2l31ki: - -NUVOTON NUMAKER M2L31KI -######################## +.. zephyr:board:: numaker_m2l31ki Overview ******** @@ -10,10 +7,6 @@ The NuMaker M2L31KI is an Internet of Things (IoT) application focused platform specially developed by Nuvoton. The NuMaker-M2L31KI is based on the NuMicro® M2L31 series MCU with ARM® -Cortex®-M23 core. -.. image:: ./m2l31ki.webp - :align: center - :alt: M2L31KI - Features: ========= - 32-bit Arm Cortex®-M23 M2L31KIDAE MCU diff --git a/boards/nuvoton/numaker_pfm_m467/doc/index.rst b/boards/nuvoton/numaker_pfm_m467/doc/index.rst index e43ad1415f6..70d4cba1ec0 100644 --- a/boards/nuvoton/numaker_pfm_m467/doc/index.rst +++ b/boards/nuvoton/numaker_pfm_m467/doc/index.rst @@ -1,7 +1,4 @@ -.. _nuvoton_pfm_m467: - -NUVOTON NUMAKER PFM M467 -######################## +.. zephyr:board:: numaker_pfm_m467 Overview ******** @@ -10,11 +7,6 @@ The NuMaker PFM M467 is an Internet of Things (IoT) application focused platform specially developed by Nuvoton. The PFM-M467 is based on the NuMicro® M467 Ethernet series MCU with ARM® -Cortex®-M4F core. -.. image:: ./pfm_m467.jpeg - :width: 720px - :align: center - :alt: PFM-M467 - Features: ========= - 32-bit Arm Cortex®-M4 M467HJHAE MCU diff --git a/boards/nuvoton/numaker_pfm_m487/doc/index.rst b/boards/nuvoton/numaker_pfm_m487/doc/index.rst index 034fac9a867..ce0e583bf30 100644 --- a/boards/nuvoton/numaker_pfm_m487/doc/index.rst +++ b/boards/nuvoton/numaker_pfm_m487/doc/index.rst @@ -1,7 +1,4 @@ -.. _nuvoton_pfm_m487: - -NUVOTON NUMAKER PFM M487 -######################## +.. zephyr:board:: numaker_pfm_m487 Overview ******** @@ -10,10 +7,6 @@ The NuMaker PFM M487 is an Internet of Things (IoT) application focused platform specially developed by Nuvoton. The PFM-M487 is based on the NuMicro® M487 Ethernet series MCU with ARM® -Cortex®-M4F core. -.. image:: pfm_m487.jpg - :align: center - :alt: PFM-M487 - Features: ========= - 32-bit Arm Cortex®-M4 M487JIDAE MCU diff --git a/doc/releases/release-notes-3.7.rst b/doc/releases/release-notes-3.7.rst index e7c54a52e21..fb8b1b59221 100644 --- a/doc/releases/release-notes-3.7.rst +++ b/doc/releases/release-notes-3.7.rst @@ -431,7 +431,7 @@ Boards & SoC Support * Added support for :zephyr:board:`Analog Devices MAX32655FTHR `: ``max32655fthr``. * Added support for :zephyr:board:`Analog Devices AD-APARD32690-SL `: ``ad_apard32690_sl``. * Added support for :zephyr:board:`Infineon Technologies CYW920829M2EVK-02 `: ``cyw920829m2evk_02``. - * Added support for :ref:`Nuvoton Numaker M2L31KI board `: ``numaker_m2l31ki``. + * Added support for :zephyr:board:`Nuvoton Numaker M2L31KI board `: ``numaker_m2l31ki``. * Added support for :zephyr:board:`Espressif ESP32-S2 DevKit-C `: ``esp32s2_devkitc``. * Added support for :zephyr:board:`Espressif ESP32-S3 DevKit-C `: ``esp32s3_devkitc``. * Added support for :zephyr:board:`Espressif ESP32-C6 DevKit-C `: ``esp32c6_devkitc``. diff --git a/samples/sensor/adc_cmp_npcx/README.rst b/samples/sensor/adc_cmp_npcx/README.rst index 3fe5ad8562c..d6a318a5a2b 100644 --- a/samples/sensor/adc_cmp_npcx/README.rst +++ b/samples/sensor/adc_cmp_npcx/README.rst @@ -8,7 +8,7 @@ Overview ******** This sample show how to use the NPCX ADC Comparator driver. The -sample supports the :ref:`npcx9m6f_evb`. +sample supports the :zephyr:board:`npcx9m6f_evb`. This application is a voltage comparator with hysteresis, upper limit is set at 1 V while lower limit is 250 mV. Initially configured to detect @@ -17,7 +17,7 @@ upper limit. Building and Running ******************** -Build the application for the :ref:`npcx9m6f_evb` board, and provide voltage +Build the application for the :zephyr:board:`npcx9m6f_evb` board, and provide voltage to ADC channel 8, when voltages cross upper/lower limits, detection messages will be printed.