fix(docs): fix docs build issue of esp32s31

This commit is contained in:
yinqingzhao
2026-04-16 19:24:57 +08:00
parent 71f335b97f
commit fa0f2c9553
5 changed files with 16 additions and 11 deletions
-3
View File
@@ -54,7 +54,6 @@ BLE_DOCS = [
'migration-guides/release-5.x/5.0/bluetooth-low-energy.rst',
]
BLE_MESH_DOCS = [
'api-guides/esp-ble-mesh/ble-mesh-index.rst',
'api-guides/esp-ble-mesh/ble-mesh-feature-list.rst',
@@ -330,7 +329,6 @@ ESP32H4_DOCS = [
ESP32S31_DOCS = [
'api-reference/system/ipc.rst',
'api-reference/peripherals/sd_pullup_requirements.rst',
'api-guides/RF_calibration.rst',
'api-guides/phy.rst',
]
@@ -452,7 +450,6 @@ github_repo = 'espressif/esp-idf'
html_context['github_user'] = 'espressif' # noqa: F405
html_context['github_repo'] = 'esp-idf' # noqa: F405
# Extra options required by sphinx_idf_theme
project_slug = 'esp-idf'
versions_url = 'https://dl.espressif.com/dl/esp-idf/idf_versions.js'
+3 -1
View File
@@ -5,4 +5,6 @@ INPUT += \
$(PROJECT_PATH)/components/esp_driver_jpeg/include/driver/jpeg_types.h \
$(PROJECT_PATH)/components/esp_driver_touch_sens/hw_ver3/include/driver/touch_version_types.h \
$(PROJECT_PATH)/components/esp_driver_touch_sens/include/driver/touch_sens.h \
$(PROJECT_PATH)/components/esp_driver_touch_sens/include/driver/touch_sens_types.h
$(PROJECT_PATH)/components/esp_driver_touch_sens/include/driver/touch_sens_types.h\
$(PROJECT_PATH)/components/esp_phy/include/esp_phy_init.h \
$(PROJECT_PATH)/components/esp_phy/include/esp_phy_cert_test.h
@@ -6,8 +6,9 @@ Introduction to Low Power Mode in Wi-Fi Scenarios
After the previous introduction to low power mode from a systemic perspective, this section delves into low power mode in Wi-Fi scenarios. Due to the complexity of Wi-Fi scenarios, basic principles of Wi-Fi power saving will be introduced before specific low power mode. This section is focused on station mode.
.. todo - add sleep-current/esp32c61_summary.inc
.. todo - add sleep-current/esp32s31_summary.inc
.. only:: not esp32c61
.. only:: not esp32c61 and not esp32s31
Choosing Low Power Mode in Wi-Fi Scenarios
---------------------------------------------
@@ -364,8 +365,9 @@ Modem-sleep Mode Configuration
- false
.. todo - add sleep-current/esp32c61_modem_sleep.inc
.. todo - add sleep-current/esp32s31_modem_sleep.inc
.. only:: not esp32c61
.. only:: not esp32c61 and not esp32s31
- Configuration Performance
@@ -378,8 +380,9 @@ Auto Light-sleep Mode + Wi-Fi Scenario Configuration
Auto Light-sleep mode in Wi-Fi scenarios does not require wake-up source configuration compared with a pure system. But the remaining part of configuration is basically the same in the two operation scenarios. Therefore, detailed introduction of configurable options, configuration steps, and recommended configurations can be found in the previous section :ref:`Deep-sleep Mode`, with the Wi-Fi-related configurations set to default.
.. todo - add eep-current/esp32c61_light_sleep.inc
.. todo - add sleep-current/esp32s31_light_sleep.inc
.. only:: not esp32c61
.. only:: not esp32c61 and not esp32s31
- Configuration Performance
@@ -6,8 +6,9 @@ Wi-Fi 场景下低功耗模式介绍
本节将结合纯系统下的功耗模式来介绍 Wi-Fi 场景下的低功耗模式。因为 Wi-Fi 场景的复杂性,本节会首先介绍 Wi-Fi 省电的基本原理,然后再介绍具体的低功耗模式。本节主要针对 station 模式。
.. todo - add sleep-current/esp32c61_summary.inc
.. todo - add sleep-current/esp32s31_summary.inc
.. only:: not esp32c61
.. only:: not esp32c61 and not esp32s31
Wi-Fi 场景如何选择低功耗模式
--------------------------------------
@@ -364,8 +365,9 @@ Modem-sleep 模式配置
- false
.. todo - add sleep-current/esp32c61_modem_sleep.inc
.. todo - add sleep-current/esp32s31_modem_sleep.inc
.. only:: not esp32c61
.. only:: not esp32c61 and not esp32s31
- 配置表现
@@ -378,8 +380,9 @@ Auto Light-sleep 模式 + Wi-Fi 场景配置
Auto Light-sleep 在 Wi-Fi 场景下的配置比纯系统下少了唤醒源的配置要求,其余几乎与纯系统下配置一致,因此可配置选项、配置步骤、推荐配置的详细介绍可以参考上文 :ref:`Deep-sleep 模式`。同时 Wi-Fi 相关配置保持默认。
.. todo - add sleep-current/esp32c61_light_sleep.inc
.. todo - add sleep-current/esp32s31_light_sleep.inc
.. only:: not esp32c61
.. only:: not esp32c61 and not esp32s31
- 配置表现