Skip to content

Commit

Permalink
docs(esp_wifi): Fix inconsistency in NAN documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
ShyamalKhachane committed Nov 1, 2023
1 parent 036fdf2 commit 77aee65
Show file tree
Hide file tree
Showing 3 changed files with 5 additions and 3 deletions.
4 changes: 3 additions & 1 deletion docs/conf_common.py
Original file line number Diff line number Diff line change
Expand Up @@ -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']

Expand Down Expand Up @@ -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,
Expand Down
2 changes: 1 addition & 1 deletion docs/en/api-reference/network/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
2 changes: 1 addition & 1 deletion docs/zh_CN/api-reference/network/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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` 目录下。

Expand Down

0 comments on commit 77aee65

Please sign in to comment.