From 8540e7a77264130ab4e9f1c3e5f9b1d4d9d9aa39 Mon Sep 17 00:00:00 2001 From: Marius Vikhammer Date: Sun, 18 Sep 2022 15:02:21 +0800 Subject: [PATCH] docs: fixed misc broken links --- components/esp_lcd/include/esp_lcd_panel_rgb.h | 1 + .../esp-ble-mesh/ble-mesh-feature-list.rst | 4 ++-- docs/en/api-reference/peripherals/mcpwm.rst | 2 +- docs/en/get-started/start-project.rst | 18 +++++++++--------- .../api-guides/esp-ble-mesh/ble-mesh-index.rst | 4 ++-- docs/zh_CN/get-started/start-project.rst | 18 +++++++++--------- 6 files changed, 24 insertions(+), 23 deletions(-) diff --git a/components/esp_lcd/include/esp_lcd_panel_rgb.h b/components/esp_lcd/include/esp_lcd_panel_rgb.h index 004cf7b5a7..a4ec006fa2 100644 --- a/components/esp_lcd/include/esp_lcd_panel_rgb.h +++ b/components/esp_lcd/include/esp_lcd_panel_rgb.h @@ -89,6 +89,7 @@ typedef bool (*esp_lcd_rgb_panel_vsync_cb_t)(esp_lcd_panel_handle_t panel, const /** * @brief Prototype for function to re-fill a bounce buffer, rather than copying from the frame buffer * + * @param[in] panel LCD panel handle, returned from `esp_lcd_new_rgb_panel()` * @param[in] bounce_buf Bounce buffer to write data into * @param[in] pos_px How many pixels already were sent to the display in this frame, in other words, * at what pixel the routine should start putting data into bounce_buf diff --git a/docs/en/api-guides/esp-ble-mesh/ble-mesh-feature-list.rst b/docs/en/api-guides/esp-ble-mesh/ble-mesh-feature-list.rst index 63e92d12c0..017af20fa4 100644 --- a/docs/en/api-guides/esp-ble-mesh/ble-mesh-feature-list.rst +++ b/docs/en/api-guides/esp-ble-mesh/ble-mesh-feature-list.rst @@ -123,11 +123,11 @@ Mesh Applications * :example_file:`Fast Provisioning Client Model Tutorial ` * :example_file:`Fast Provisioning Server Model Tutorial ` * :example:`Example ` - * `Demo Video `__ + * `Demo Video `__ * ESP-BLE-MESH and Wi-Fi Coexistence * :example_file:`Tutorial ` * :example:`Example ` - * `Demo Video `__ + * `Demo Video `__ * ESP-BLE-MESH Console Commands * :example:`Example ` diff --git a/docs/en/api-reference/peripherals/mcpwm.rst b/docs/en/api-reference/peripherals/mcpwm.rst index 28ecc4489d..f33cdf94bf 100644 --- a/docs/en/api-reference/peripherals/mcpwm.rst +++ b/docs/en/api-reference/peripherals/mcpwm.rst @@ -33,7 +33,7 @@ Description of the MCPWM functionality is divided into the following sections: - `Resource Allocation and Initialization <#resource-allocation-and-initialization>`__ - covers how to allocate various MCPWM objects, like timers, operators, comparators, generators and so on. These objects are the basis of the following IO setting and control functions. - `Timer Operations and Events <#timer-operations-and-events>`__ - describes control functions and event callbacks that supported by the MCPWM timer. -- `Comparator Operations and Events `__ - describes control functions and event callbacks that supported by the MCPWM comparator. +- `Comparator Operations and Events <#comparator-operations-and-events>`__ - describes control functions and event callbacks that supported by the MCPWM comparator. - `Generator Actions on Events <#generator-actions-on-events>`__ - describes how to set actions for MCPWM generators on particular events that generated by the MCPWM timer and comparators. - `Classical PWM Waveforms and Generator Configurations <#classical-pwm-waveforms-and-generator-configurations>`__ - demonstrates some classical PWM waveforms that can be achieved by configuring generator actions. - `Dead Time <#dead-time>`__ - describes how to set dead time for MCPWM generators. diff --git a/docs/en/get-started/start-project.rst b/docs/en/get-started/start-project.rst index 2cfa540f9b..3d84cecc60 100644 --- a/docs/en/get-started/start-project.rst +++ b/docs/en/get-started/start-project.rst @@ -381,31 +381,31 @@ ESP-IDF supports Python 3.7 or newer. It is recommended to upgrade your operatin A BSP typically supports all of the hardware components provided on development board. Apart from the pinout definition and initialization functions, a BSP ships with drivers for the external components such as sensors, displays, audio codecs etc. - The BSPs are distributed via `IDF Component Manager <../api-guides/tools/idf-component-manager>`_, so they can be found in `IDF Component Registry `_. + The BSPs are distributed via :doc:`IDF Component Manager `, so they can be found in `IDF Component Registry `_. .. only:: esp32 **Here's an example of how to add ESP-WROVER-KIT BSP to your project:** - + .. code-block:: bash - - idf.py add-dependency esp_wrover_kit + + idf.py add-dependency esp_wrover_kit .. only:: esp32s2 **Here's an example of how to add ESP32-S2-Kaluga-Kit BSP to your project:** - + .. code-block:: bash - + idf.py add-dependency esp32_s2_kaluga_kit .. only:: esp32s3 **Here's an example of how to add ESP-BOX BSP to your project:** - + .. code-block:: bash - - idf.py add-dependency esp-box + + idf.py add-dependency esp-box More examples of BSP usage can be found in `BSP examples folder `_. diff --git a/docs/zh_CN/api-guides/esp-ble-mesh/ble-mesh-index.rst b/docs/zh_CN/api-guides/esp-ble-mesh/ble-mesh-index.rst index 5afeac626d..37d1f2fdc3 100644 --- a/docs/zh_CN/api-guides/esp-ble-mesh/ble-mesh-index.rst +++ b/docs/zh_CN/api-guides/esp-ble-mesh/ble-mesh-index.rst @@ -231,8 +231,8 @@ ESP-BLE-MESH 演示视频 ====================== * `Provisioning of ESP-BLE-MESH nodes using Smartphone App `_ -* `Espressif Fast Provisioning using ESP-BLE-MESH App `_ -* `Espressif ESP-BLE-MESH and Wi-Fi Coexistence `_ +* `Espressif Fast Provisioning using ESP-BLE-MESH App `_ +* `Espressif ESP-BLE-MESH and Wi-Fi Coexistence `_ ESP-BLE-MESH 常见问题手册 diff --git a/docs/zh_CN/get-started/start-project.rst b/docs/zh_CN/get-started/start-project.rst index 751cba1078..9e5800b277 100644 --- a/docs/zh_CN/get-started/start-project.rst +++ b/docs/zh_CN/get-started/start-project.rst @@ -381,31 +381,31 @@ ESP-IDF 支持 Python 3.7 及以上版本，建议升级操作系统到最新版 一般来说，BSP 支持开发板上所有硬件组件。除了管脚定义和初始化功能外，BSP 还附带如传感器、显示器、音频编解码器等外部元件的驱动程序。 - BSP 通过 `IDF 组件管理器 <../api-guides/tools/idf-component-manager>`_ 发布，您可以前往 `IDF 组件注册器 `_ 进行下载。 + BSP 通过 :doc:`IDF 组件管理器 ` 发布，您可以前往 `IDF 组件注册器 `_ 进行下载。 .. only:: esp32 **以下示例演示了如何将 ESP-WROVER-KIT BSP 添加到项目中：** - + .. code-block:: bash - - idf.py add-dependency esp_wrover_kit + + idf.py add-dependency esp_wrover_kit .. only:: esp32s2 **以下示例演示了如何将 ESP32-S2-Kaluga-Kit BSP 添加到项目中：** - + .. code-block:: bash - + idf.py add-dependency esp32_s2_kaluga_kit .. only:: esp32s3 **以下示例演示了如何将 ESP-BOX BSP 添加到项目中：** - + .. code-block:: bash - - idf.py add-dependency esp-box + + idf.py add-dependency esp-box 更多有关使用 BSP 的示例，请前往 `BSP 示例文件夹 `_。