docs(sphinx-lint): Fix issues reported by sphinx-lint before adding it to pre-commit

2024-01-19 14:40:33 +08:00
parent 9ba5f4dab2
commit 22a053f1fc
195 changed files with 2385 additions and 2393 deletions
@@ -18,4 +18,4 @@ API 参考
 -------------

 .. include-build-file:: inc/esp_app_trace.inc
-.. include-build-file:: inc/esp_sysview_trace.inc
+.. include-build-file:: inc/esp_sysview_trace.inc
@@ -1 +1 @@
-.. include:: ../../../en/api-reference/system/efuse.rst
+.. include:: ../../../en/api-reference/system/efuse.rst
@@ -15,7 +15,7 @@
 .. only:: SOC_BT_SUPPORTED

    .. note::
-    
+
        蓝牙栈各模块通过调用专用回调函数向应用程序传递事件，而非通过事件循环库传递。

 调用 ``esp_event`` API
@@ -134,7 +134,7 @@
      - :cpp:func:`esp_event_loop_create_default`
    * - :cpp:func:`esp_event_loop_delete`
      - :cpp:func:`esp_event_loop_delete_default`
-    * - :cpp:func:`esp_event_handler_register_with` 
+    * - :cpp:func:`esp_event_handler_register_with`
      - :cpp:func:`esp_event_handler_register`
    * - :cpp:func:`esp_event_handler_unregister_with`
      - :cpp:func:`esp_event_handler_unregister`
@@ -81,9 +81,9 @@ Vanilla FreeRTOS 提供以下用于创建任务的函数：

 不同于普通的任务创建函数 API，``...PinnedToCore()`` 版本的任务创建函数 API 有额外的 ``xCoreID`` 参数，用于指定所创建任务的核亲和性。核亲和性的有效值包括：

-	``0``：将创建的任务分配给核 0
-	``1``：将创建的任务分配给核 1
-	``tskNO_AFFINITY``：支持任务在两个核上运行
+- ``0``：将创建的任务分配给核 0
+- ``1``：将创建的任务分配给核 1
+- ``tskNO_AFFINITY``：支持任务在两个核上运行

 注意，IDF FreeRTOS 仍支持普通的任务创建函数，但这些标准函数已经过调整，会内部调用其 ``...PinnedToCore()`` 版本，同时将核亲和性设置为 ``tskNO_AFFINITY``。

@@ -26,4 +26,4 @@ ESP-IDF 中提供了对大内存范围进行简单内存测试的示例，请前
 API 参考
 -------------

-.. include-build-file:: inc/himem.inc
+.. include-build-file:: inc/himem.inc
@@ -1,2 +1 @@
 .. include:: ../../../en/api-reference/system/inc/espefuse_summary_ESP32-C2.rst
-    
@@ -1 +1 @@
-.. include:: ../../../en/api-reference/system/inc/espefuse_summary_ESP32-C3.rst
+.. include:: ../../../en/api-reference/system/inc/espefuse_summary_ESP32-C3.rst
@@ -1 +1 @@
-.. include:: ../../../en/api-reference/system/inc/espefuse_summary_ESP32-C6.rst
+.. include:: ../../../en/api-reference/system/inc/espefuse_summary_ESP32-C6.rst
@@ -1 +1 @@
-.. include:: ../../../en/api-reference/system/inc/espefuse_summary_ESP32-H2.rst
+.. include:: ../../../en/api-reference/system/inc/espefuse_summary_ESP32-H2.rst
@@ -1 +1 @@
-.. include:: ../../../en/api-reference/system/inc/espefuse_summary_ESP32-P4.rst
+.. include:: ../../../en/api-reference/system/inc/espefuse_summary_ESP32-P4.rst
@@ -1 +1 @@
-.. include:: ../../../en/api-reference/system/inc/espefuse_summary_ESP32-S2.rst
+.. include:: ../../../en/api-reference/system/inc/espefuse_summary_ESP32-S2.rst
@@ -1 +1 @@
-.. include:: ../../../en/api-reference/system/inc/espefuse_summary_ESP32-S3.rst
+.. include:: ../../../en/api-reference/system/inc/espefuse_summary_ESP32-S3.rst
@@ -1 +1 @@
-.. include:: ../../../en/api-reference/system/inc/espefuse_summary_ESP32.rst
+.. include:: ../../../en/api-reference/system/inc/espefuse_summary_ESP32.rst
@@ -28,4 +28,4 @@
 +               +---------------------------------------+-------------------------------------+
 |               |                  无                   | 使用 :cpp:func:`esp_pm_configure`   |
 |               |                                       | 为二者设置最小值                    |
-+---------------+---------------------------------------+-------------------------------------+
+---------------+---------------------------------------+-------------------------------------+
@@ -1 +1 @@
-TO BE UPDATED IDF-7672
+TO BE UPDATED IDF-7672
@@ -55,7 +55,7 @@

 .. note::

-    在关键部分中断被禁用，因此只能使用 ``ESP_DRAM_LOGx``（首选）或 ``ESP_EARLY_LOGx`` 宏。尽管这样可以输出日志，但最好可以调整程序使其不用输出日志。
+    在关键部分中断被禁用，因此只能使用 ``ESP_DRAM_LOGx`` （首选）或 ``ESP_EARLY_LOGx`` 宏。尽管这样可以输出日志，但最好可以调整程序使其不用输出日志。

 如需在文件或组件范围内覆盖默认的日志级别，请定义 ``LOG_LOCAL_LEVEL`` 宏。

@@ -56,7 +56,7 @@ OTA 数据分区的容量是 2 个 flash 扇区的大小（0x2000 字节），
                               则仅会选取一次。在引导加载程序中，状态立即变为
                               ``ESP_OTA_IMG_PENDING_VERIFY``。
 ESP_OTA_IMG_PENDING_VERIFY    如使能 :ref:`CONFIG_BOOTLOADER_APP_ROLLBACK_ENABLE`，
-                               则不会选取，状态变为``ESP_OTA_IMG_ABORTED``。
+                               则不会选取，状态变为 ``ESP_OTA_IMG_ABORTED``。
 =============================  ========================================================

 如果 :ref:`CONFIG_BOOTLOADER_APP_ROLLBACK_ENABLE` 没有使能（默认情况），则 :cpp:func:`esp_ota_mark_app_valid_cancel_rollback` 和 :cpp:func:`esp_ota_mark_app_invalid_rollback_and_reboot` 为可选功能，``ESP_OTA_IMG_NEW`` 和 ``ESP_OTA_IMG_PENDING_VERIFY`` 不会使用。
@@ -153,9 +153,9 @@ Kconfig 中的 :ref:`CONFIG_BOOTLOADER_APP_ROLLBACK_ENABLE` 可以帮助用户
                if (data_read > sizeof(esp_image_header_t) + sizeof(esp_image_segment_header_t) + sizeof(esp_app_desc_t)) {
                    // check current version with downloading
                    if (esp_efuse_check_secure_version(new_app_info.secure_version) == false) {
-                    	ESP_LOGE(TAG, "This a new app can not be downloaded due to a secure version is lower than stored in efuse.");
-                    	http_cleanup(client);
-                    	task_fatal_error();
+                      ESP_LOGE(TAG, "This a new app can not be downloaded due to a secure version is lower than stored in efuse.");
+                      http_cleanup(client);
+                      task_fatal_error();
                    }

                    image_header_was_checked = true;
@@ -322,4 +322,3 @@ OTA 升级失败排查
    :figclass: align-center

    OTA 升级失败时如何排查（点击放大）
-
@@ -401,7 +401,7 @@ flash 断电

    在函数 :cpp:func:`esp_deep_sleep_start` 前增加以下代码即可避免额外电流消耗::

-	rtc_gpio_isolate(GPIO_NUM_12);
+        rtc_gpio_isolate(GPIO_NUM_12);

 .. only:: esp32c2 or esp32c3
				`@@ -1,2 +1 @@`
				`.. include:: ../../../en/api-reference/system/inc/espefuse_summary_ESP32-C2.rst`