diff --git a/docs/conf_common.py b/docs/conf_common.py index 4e57b76ea2..d3440cea20 100644 --- a/docs/conf_common.py +++ b/docs/conf_common.py @@ -1,4 +1,3 @@ -# -*- coding: utf-8 -*- # # Common (non-language-specific) configuration for Sphinx # @@ -290,9 +289,17 @@ ESP32C3_DOCS = ['hw-reference/esp32c3/**', 'api-guides/RF_calibration.rst', 'api ESP32C2_DOCS = ['api-guides/RF_calibration.rst', 'api-guides/phy.rst'] -ESP32C5_DOCS = ['api-guides/phy.rst', 'api-reference/peripherals/sd_pullup_requirements.rst'] +ESP32C5_DOCS = [ + 'api-guides/phy.rst', + 'api-reference/peripherals/sd_pullup_requirements.rst', + 'api-guides/RF_calibration.rst', +] -ESP32C61_DOCS = ['api-guides/phy.rst', 'api-reference/peripherals/sd_pullup_requirements.rst'] +ESP32C61_DOCS = [ + 'api-guides/phy.rst', + 'api-reference/peripherals/sd_pullup_requirements.rst', + 'api-guides/RF_calibration.rst', +] ESP32C6_DOCS = [ 'api-guides/RF_calibration.rst', @@ -458,7 +465,7 @@ with open('../page_redirects.txt') as f: ] for line in lines: # check for well-formed entries if len(line.split(' ')) != 2: - raise RuntimeError('Invalid line in page_redirects.txt: %s' % line) + raise RuntimeError(f'Invalid line in page_redirects.txt: {line}') html_redirect_pages = [tuple(line.split(' ')) for line in lines] html_static_path = ['../_static'] @@ -480,7 +487,7 @@ def conf_setup(app, config): f'This document is not updated for {config.idf_target.upper()} yet, so some of the content may not be correct.' ) - add_warnings_file = '{}/../docs_not_updated/{}.txt'.format(app.confdir, config.idf_target) + add_warnings_file = f'{app.confdir}/../docs_not_updated/{config.idf_target}.txt' if config.idf_target in QEMU_TARGETS: app.tags.add('TARGET_SUPPORT_QEMU') diff --git a/docs/docs_not_updated/esp32c5.txt b/docs/docs_not_updated/esp32c5.txt index 3124d00310..72962a4545 100644 --- a/docs/docs_not_updated/esp32c5.txt +++ b/docs/docs_not_updated/esp32c5.txt @@ -6,8 +6,6 @@ api-guides/esp-wifi-mesh.rst api-guides/inc/external-ram-esp32-notes.rst api-guides/current-consumption-measurement-modules.rst api-guides/wifi-security.rst -api-guides/openthread.rst -api-reference/template.rst api-reference/storage/vfs.rst api-reference/storage/spiffs.rst api-reference/storage/nvs_encryption.rst @@ -21,7 +19,6 @@ api-reference/storage/fatfsgen.rst api-reference/storage/index.rst api-reference/storage/nvs_partition_parse.rst api-reference/peripherals/ecdsa.rst -api-reference/network/esp_openthread.rst api-reference/network/esp_dpp.rst api-reference/network/esp_now.rst api-reference/network/esp-wifi-mesh.rst @@ -32,5 +29,3 @@ api-reference/network/index.rst api-reference/system/sleep_modes.rst api-reference/system/power_management.rst api-reference/system/inc/power_management_esp32c5.rst -api-reference/index.rst -api-reference/protocols/esp_crt_bundle.rst diff --git a/docs/docs_not_updated/esp32c61.txt b/docs/docs_not_updated/esp32c61.txt index f6522a60f8..cbe60a6fb2 100644 --- a/docs/docs_not_updated/esp32c61.txt +++ b/docs/docs_not_updated/esp32c61.txt @@ -13,8 +13,6 @@ api-guides/inc/external-ram-esp32-notes.rst api-guides/dfu.rst api-guides/current-consumption-measurement-modules.rst api-guides/wifi-security.rst -api-guides/openthread.rst -api-reference/template.rst api-reference/storage/vfs.rst api-reference/storage/spiffs.rst api-reference/storage/nvs_encryption.rst @@ -35,7 +33,6 @@ api-reference/peripherals/usb_host/usb_host_notes_usbh.rst api-reference/peripherals/usb_host/usb_host_notes_design.rst api-reference/peripherals/usb_device.rst api-reference/peripherals/sd_pullup_requirements.rst -api-reference/network/esp_openthread.rst api-reference/network/esp_eth.rst api-reference/network/esp_netif_driver.rst api-reference/network/esp_dpp.rst @@ -50,7 +47,6 @@ api-reference/system/sleep_modes.rst api-reference/system/app_trace.rst api-reference/system/power_management.rst api-reference/system/inc/power_management_esp32c61.rst -api-reference/error-codes.rst api-reference/index.rst api-reference/protocols/icmp_echo.rst api-reference/protocols/mqtt.rst diff --git a/docs/doxygen/Doxyfile_esp32c5 b/docs/doxygen/Doxyfile_esp32c5 index a86358c7db..ce907e0796 100644 --- a/docs/doxygen/Doxyfile_esp32c5 +++ b/docs/doxygen/Doxyfile_esp32c5 @@ -16,3 +16,5 @@ INPUT += \ $(PROJECT_PATH)/components/ulp/lp_core/shared/include/ulp_lp_core_lp_uart_shared.h \ $(PROJECT_PATH)/components/bt/include/esp32c5/include/esp_bt.h \ $(PROJECT_PATH)/components/bt/include/$(IDF_TARGET)/include/esp_bt_vs.h \ + $(PROJECT_PATH)/components/esp_phy/include/esp_phy_init.h \ + $(PROJECT_PATH)/components/esp_phy/include/esp_phy_cert_test.h \ diff --git a/docs/doxygen/Doxyfile_esp32c61 b/docs/doxygen/Doxyfile_esp32c61 index f332f112e2..74f603a122 100644 --- a/docs/doxygen/Doxyfile_esp32c61 +++ b/docs/doxygen/Doxyfile_esp32c61 @@ -3,3 +3,5 @@ INPUT += \ $(PROJECT_PATH)/components/esp_wifi/include/esp_wifi_he.h \ $(PROJECT_PATH)/components/bt/include/esp32c6/include/esp_bt.h \ $(PROJECT_PATH)/components/bt/include/esp32c6/include/esp_bt_vs.h \ + $(PROJECT_PATH)/components/esp_phy/include/esp_phy_init.h \ + $(PROJECT_PATH)/components/esp_phy/include/esp_phy_cert_test.h \ diff --git a/docs/en/api-guides/index.rst b/docs/en/api-guides/index.rst index 8b905f0e07..f0f2d85fac 100644 --- a/docs/en/api-guides/index.rst +++ b/docs/en/api-guides/index.rst @@ -39,7 +39,7 @@ API Guides partition-tables performance/index reproducible-builds - :(SOC_WIFI_SUPPORTED or SOC_BT_SUPPORTED or SOC_IEEE802154_SUPPORTED) and not esp32c5 and not esp32c61: RF_calibration + :(SOC_WIFI_SUPPORTED or SOC_BT_SUPPORTED or SOC_IEEE802154_SUPPORTED): RF_calibration stdio thread-local-storage tools/index diff --git a/docs/en/api-guides/openthread.rst b/docs/en/api-guides/openthread.rst index a0d8f38eee..9f138b1306 100644 --- a/docs/en/api-guides/openthread.rst +++ b/docs/en/api-guides/openthread.rst @@ -13,7 +13,7 @@ OpenThread can run under the following modes on Espressif chips: Standalone Node +++++++++++++++ -The full OpenThread stack and the application layer run on the same chip. This mode is available on chips with 15.4 radio such as ESP32-H2 and ESP32-C6. +The full OpenThread stack and the application layer run on the same chip. This mode is available on chips with 15.4 radio such as ESP32-H2, ESP32-C6 and ESP32-C5. Radio Co-Processor (RCP) ++++++++++++++++++++++++ diff --git a/docs/zh_CN/api-guides/index.rst b/docs/zh_CN/api-guides/index.rst index 89fdc7ba5a..15d921cc38 100644 --- a/docs/zh_CN/api-guides/index.rst +++ b/docs/zh_CN/api-guides/index.rst @@ -39,7 +39,7 @@ API 指南 partition-tables performance/index reproducible-builds - :(SOC_WIFI_SUPPORTED or SOC_BT_SUPPORTED or SOC_IEEE802154_SUPPORTED) and not esp32c5 and not esp32c61: RF_calibration + :(SOC_WIFI_SUPPORTED or SOC_BT_SUPPORTED or SOC_IEEE802154_SUPPORTED): RF_calibration stdio thread-local-storage tools/index diff --git a/docs/zh_CN/api-guides/openthread.rst b/docs/zh_CN/api-guides/openthread.rst index 548010861d..af5f348d28 100644 --- a/docs/zh_CN/api-guides/openthread.rst +++ b/docs/zh_CN/api-guides/openthread.rst @@ -13,7 +13,7 @@ OpenThread 协议栈运行模式 独立节点模式 ++++++++++++ -在此模式下，完整的 OpenThread 协议栈及其应用层在同一芯片上运行，适用于支持 15.4 无线通信协议的芯片，如 ESP32-H2, ESP32-C6。 +在此模式下，完整的 OpenThread 协议栈及其应用层在同一芯片上运行，适用于支持 15.4 无线通信协议的芯片，如 ESP32-H2, ESP32-C5, ESP32-C6。 无线协处理器 (RCP) 模式 +++++++++++++++++++++++++