From 77aee65708c82e4ca02a47c2e770767b7f34019f Mon Sep 17 00:00:00 2001 From: Shyamal Khachane Date: Wed, 1 Nov 2023 11:02:12 +0530 Subject: [PATCH] docs(esp_wifi): Fix inconsistency in NAN documentation --- docs/conf_common.py | 4 +++- docs/en/api-reference/network/index.rst | 2 +- docs/zh_CN/api-reference/network/index.rst | 2 +- 3 files changed, 5 insertions(+), 3 deletions(-) diff --git a/docs/conf_common.py b/docs/conf_common.py index 05d2bb9748..6d286875c9 100644 --- a/docs/conf_common.py +++ b/docs/conf_common.py @@ -63,12 +63,13 @@ BLUFI_DOCS = ['api-guides/blufi.rst', WIFI_DOCS = ['api-guides/wifi.rst', 'api-guides/wifi-security.rst', 'api-guides/wireshark-user-guide.rst', - 'api-reference/network/esp_nan.rst', 'api-reference/network/esp_now.rst', 'api-reference/network/esp_smartconfig.rst', 'api-reference/network/esp_wifi.rst', 'api-reference/network/esp_dpp.rst'] +NAN_DOCS = ['api-reference/network/esp_nan.rst'] + WIFI_MESH_DOCS = ['api-guides/esp-wifi-mesh.rst', 'api-reference/network/esp-wifi-mesh.rst'] @@ -223,6 +224,7 @@ conditional_include_dict = {'SOC_BT_SUPPORTED':BT_DOCS, 'SOC_SDM_SUPPORTED':SDM_DOCS, 'SOC_WIFI_MESH_SUPPORT':WIFI_MESH_DOCS, 'SOC_SPI_SUPPORT_SLAVE_HD_VER2':SPI_SLAVE_HD_DOCS, + 'SOC_WIFI_NAN_SUPPORT':NAN_DOCS, 'esp32':ESP32_DOCS, 'esp32s2':ESP32S2_DOCS, 'esp32s3':ESP32S3_DOCS, diff --git a/docs/en/api-reference/network/index.rst b/docs/en/api-reference/network/index.rst index 17cc3a5090..0c874ead99 100644 --- a/docs/en/api-reference/network/index.rst +++ b/docs/en/api-reference/network/index.rst @@ -16,7 +16,7 @@ Networking APIs esp_smartconfig esp_wifi esp_dpp - esp_nan + :SOC_WIFI_NAN_SUPPORT: esp_nan Code examples for the Wi-Fi API are provided in the :example:`wifi` directory of ESP-IDF examples. diff --git a/docs/zh_CN/api-reference/network/index.rst b/docs/zh_CN/api-reference/network/index.rst index dbd53d701d..7acaac9aec 100644 --- a/docs/zh_CN/api-reference/network/index.rst +++ b/docs/zh_CN/api-reference/network/index.rst @@ -16,7 +16,7 @@ esp_smartconfig esp_wifi esp_dpp - esp_nan + :SOC_WIFI_NAN_SUPPORT: esp_nan 本部分的 Wi-Fi API 示例代码存放在 ESP-IDF 示例项目的 :example:`wifi` 目录下。