Merge branch 'docs/update_nan_docs' into 'master'

Fix inconsistency in NAN documentation Closes WIFI-6298 See merge request espressif/esp-idf!26817
espressif · Nov 1, 2023 · ccc6a57 · ccc6a57
2 parents 8414400 + 77aee65
commit ccc6a57
Show file tree

Hide file tree

Showing 3 changed files with 5 additions and 3 deletions.
diff --git a/docs/conf_common.py b/docs/conf_common.py
@@ -63,12 +63,13 @@
 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 @@
                             '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
@@ -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
@@ -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` 目录下。