Skip to content

Commit d20fb26

Browse files
committed
Merge branch 'docs/misc_c5_c61_v5.5' into 'release/v5.5'
docs(misc): cleanup docs for C5 and C61 (v5.5) See merge request espressif/esp-idf!41329
2 parents 7b478f3 + ee777b0 commit d20fb26

File tree

9 files changed

+20
-16
lines changed

9 files changed

+20
-16
lines changed

docs/conf_common.py

Lines changed: 12 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
1-
# -*- coding: utf-8 -*-
21
#
32
# Common (non-language-specific) configuration for Sphinx
43
#
@@ -285,9 +284,17 @@
285284

286285
ESP32C2_DOCS = ['api-guides/RF_calibration.rst', 'api-guides/phy.rst']
287286

288-
ESP32C5_DOCS = ['api-guides/phy.rst', 'api-reference/peripherals/sd_pullup_requirements.rst']
287+
ESP32C5_DOCS = [
288+
'api-guides/phy.rst',
289+
'api-reference/peripherals/sd_pullup_requirements.rst',
290+
'api-guides/RF_calibration.rst',
291+
]
289292

290-
ESP32C61_DOCS = ['api-guides/phy.rst', 'api-reference/peripherals/sd_pullup_requirements.rst']
293+
ESP32C61_DOCS = [
294+
'api-guides/phy.rst',
295+
'api-reference/peripherals/sd_pullup_requirements.rst',
296+
'api-guides/RF_calibration.rst',
297+
]
291298

292299
ESP32C6_DOCS = [
293300
'api-guides/RF_calibration.rst',
@@ -448,7 +455,7 @@
448455
]
449456
for line in lines: # check for well-formed entries
450457
if len(line.split(' ')) != 2:
451-
raise RuntimeError('Invalid line in page_redirects.txt: %s' % line)
458+
raise RuntimeError(f'Invalid line in page_redirects.txt: {line}')
452459
html_redirect_pages = [tuple(line.split(' ')) for line in lines]
453460

454461
html_static_path = ['../_static']
@@ -470,7 +477,7 @@ def conf_setup(app, config):
470477
f'This document is not updated for {config.idf_target.upper()} yet, so some of the content may not be correct.'
471478
)
472479

473-
add_warnings_file = '{}/../docs_not_updated/{}.txt'.format(app.confdir, config.idf_target)
480+
add_warnings_file = f'{app.confdir}/../docs_not_updated/{config.idf_target}.txt'
474481

475482
if config.idf_target in QEMU_TARGETS:
476483
app.tags.add('TARGET_SUPPORT_QEMU')

docs/docs_not_updated/esp32c5.txt

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,6 @@ api-guides/esp-wifi-mesh.rst
66
api-guides/inc/external-ram-esp32-notes.rst
77
api-guides/current-consumption-measurement-modules.rst
88
api-guides/wifi-security.rst
9-
api-guides/openthread.rst
10-
api-reference/template.rst
119
api-reference/storage/vfs.rst
1210
api-reference/storage/spiffs.rst
1311
api-reference/storage/nvs_encryption.rst
@@ -23,7 +21,6 @@ api-reference/storage/nvs_partition_parse.rst
2321
api-reference/peripherals/touch_pad.rst
2422
api-reference/peripherals/index.rst
2523
api-reference/peripherals/ecdsa.rst
26-
api-reference/network/esp_openthread.rst
2724
api-reference/network/esp_dpp.rst
2825
api-reference/network/esp_now.rst
2926
api-reference/network/esp-wifi-mesh.rst

docs/docs_not_updated/esp32c61.txt

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,6 @@ api-guides/inc/external-ram-esp32-notes.rst
1313
api-guides/dfu.rst
1414
api-guides/current-consumption-measurement-modules.rst
1515
api-guides/wifi-security.rst
16-
api-guides/openthread.rst
17-
api-reference/template.rst
1816
api-reference/storage/vfs.rst
1917
api-reference/storage/spiffs.rst
2018
api-reference/storage/nvs_encryption.rst
@@ -50,7 +48,6 @@ api-reference/peripherals/sd_pullup_requirements.rst
5048
api-reference/peripherals/index.rst
5149
api-reference/peripherals/ldo_regulator.rst
5250
api-reference/peripherals/jpeg.rst
53-
api-reference/network/esp_openthread.rst
5451
api-reference/network/esp_eth.rst
5552
api-reference/network/esp_netif_driver.rst
5653
api-reference/network/esp_dpp.rst
@@ -68,7 +65,6 @@ api-reference/system/power_management.rst
6865
api-reference/system/inc/show-efuse-table_ESP32-C61.rst
6966
api-reference/system/inc/power_management_esp32c61.rst
7067
api-reference/system/inc/espefuse_summary_ESP32-C61.rst
71-
api-reference/error-codes.rst
7268
api-reference/index.rst
7369
api-reference/protocols/icmp_echo.rst
7470
api-reference/protocols/esp_serial_slave_link.rst

docs/doxygen/Doxyfile_esp32c5

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,3 +16,5 @@ INPUT += \
1616
$(PROJECT_PATH)/components/ulp/lp_core/shared/include/ulp_lp_core_lp_uart_shared.h \
1717
$(PROJECT_PATH)/components/bt/include/esp32c5/include/esp_bt.h \
1818
$(PROJECT_PATH)/components/bt/include/$(IDF_TARGET)/include/esp_bt_vs.h \
19+
$(PROJECT_PATH)/components/esp_phy/include/esp_phy_init.h \
20+
$(PROJECT_PATH)/components/esp_phy/include/esp_phy_cert_test.h \

docs/doxygen/Doxyfile_esp32c61

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,3 +3,5 @@ INPUT += \
33
$(PROJECT_PATH)/components/esp_wifi/include/esp_wifi_he.h \
44
$(PROJECT_PATH)/components/bt/include/esp32c6/include/esp_bt.h \
55
$(PROJECT_PATH)/components/bt/include/esp32c6/include/esp_bt_vs.h \
6+
$(PROJECT_PATH)/components/esp_phy/include/esp_phy_init.h \
7+
$(PROJECT_PATH)/components/esp_phy/include/esp_phy_cert_test.h \

docs/en/api-guides/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ API Guides
3939
partition-tables
4040
performance/index
4141
reproducible-builds
42-
:(SOC_WIFI_SUPPORTED or SOC_BT_SUPPORTED or SOC_IEEE802154_SUPPORTED) and not esp32c5 and not esp32c61: RF_calibration
42+
:(SOC_WIFI_SUPPORTED or SOC_BT_SUPPORTED or SOC_IEEE802154_SUPPORTED): RF_calibration
4343
stdio
4444
thread-local-storage
4545
tools/index

docs/en/api-guides/openthread.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ OpenThread can run under the following modes on Espressif chips:
1313
Standalone Node
1414
+++++++++++++++
1515

16-
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.
16+
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.
1717

1818
Radio Co-Processor (RCP)
1919
++++++++++++++++++++++++

docs/zh_CN/api-guides/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ API 指南
3939
partition-tables
4040
performance/index
4141
reproducible-builds
42-
:(SOC_WIFI_SUPPORTED or SOC_BT_SUPPORTED or SOC_IEEE802154_SUPPORTED) and not esp32c5 and not esp32c61: RF_calibration
42+
:(SOC_WIFI_SUPPORTED or SOC_BT_SUPPORTED or SOC_IEEE802154_SUPPORTED): RF_calibration
4343
stdio
4444
thread-local-storage
4545
tools/index

docs/zh_CN/api-guides/openthread.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ OpenThread 协议栈运行模式
1313
独立节点模式
1414
++++++++++++
1515

16-
在此模式下,完整的 OpenThread 协议栈及其应用层在同一芯片上运行,适用于支持 15.4 无线通信协议的芯片,如 ESP32-H2, ESP32-C6。
16+
在此模式下,完整的 OpenThread 协议栈及其应用层在同一芯片上运行,适用于支持 15.4 无线通信协议的芯片,如 ESP32-H2, ESP32-C5, ESP32-C6。
1717

1818
无线协处理器 (RCP) 模式
1919
+++++++++++++++++++++++++

0 commit comments

Comments
 (0)