Merge branch 'docs/remove_wifi_related_documentation_for_esp32h2' into 'master'

docs: remove WiFi related documentation for ESP32-H2 See merge request espressif/esp-idf!27026
2025-08-02 20:24:32 +02:00 · 2023-12-05 09:58:06 +08:00
parent b61ea3ba97 bd1825f9b1
commit 4cd0a6a4b1
9 changed files with 43 additions and 39 deletions
--- a/docs/conf_common.py
+++ b/docs/conf_common.py
@@ -66,7 +66,9 @@ WIFI_DOCS = ['api-guides/wifi.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']
+             'api-reference/network/esp_dpp.rst',
+             'api-reference/provisioning/provisioning.rst',
+             'api-reference/provisioning/wifi_provisioning.rst']

 NAN_DOCS = ['api-reference/network/esp_nan.rst']

--- a/docs/en/api-reference/provisioning/protocomm.rst
+++ b/docs/en/api-reference/provisioning/protocomm.rst
@@ -28,8 +28,11 @@ Protocomm provides the framework for various transports:
    :SOC_WIFI_SUPPORTED: - Wi-Fi (SoftAP + HTTPD)
    - Console, in which case the handler invocation is automatically taken care of on the device side. See Transport Examples below for code snippets.

+Note that for protocomm_security1 and protocomm_security2, the client still needs to establish sessions by performing the two-way handshake.

-Note that for protocomm_security1 and protocomm_security2, the client still needs to establish sessions by performing the two-way handshake. See :doc:`provisioning` for more details about the secure handshake logic.
+.. only:: SOC_WIFI_SUPPORTED
+
+    See :doc:`provisioning` for more details about the secure handshake logic.

 .. _enabling-protocomm-security-version:

--- a/docs/en/api-reference/provisioning/provisioning.rst
+++ b/docs/en/api-reference/provisioning/provisioning.rst
@@ -1,5 +1,3 @@
-:orphan:
-
 Unified Provisioning
 ^^^^^^^^^^^^^^^^^^^^

--- a/docs/en/api-reference/provisioning/wifi_provisioning.rst
+++ b/docs/en/api-reference/provisioning/wifi_provisioning.rst
@@ -1,5 +1,3 @@
-:orphan:
-
 Wi-Fi Provisioning
 ==================

--- a/docs/en/security/security.rst
+++ b/docs/en/security/security.rst
@@ -211,6 +211,8 @@ UART Download Mode
 Product Security
 ----------------

+.. only:: SOC_WIFI_SUPPORTED
+
    Secure Provisioning
    ~~~~~~~~~~~~~~~~~~~

--- a/docs/zh_CN/api-reference/provisioning/protocomm.rst
+++ b/docs/zh_CN/api-reference/provisioning/protocomm.rst
@@ -28,8 +28,11 @@ Protocomm 为以下各种传输提供框架：
    :SOC_WIFI_SUPPORTED: - Wi-Fi (SoftAP + HTTPD)
    - 控制台：使用该传输方案时，设备端会自动调用处理程序。相关代码片段，请参见下文传输示例。

+请注意，对于 ``protocomm_security1`` 和 ``protocomm_security2``，客户端仍需要执行双向握手来建立会话。

-请注意，对于 ``protocomm_security1`` 和 ``protocomm_security2``，客户端仍需要执行双向握手来建立会话。关于安全握手逻辑的详情，请参阅 :doc:`provisioning`。
+.. only:: SOC_WIFI_SUPPORTED
+
+    关于安全握手逻辑的详情，请参阅 :doc:`provisioning`。

 .. _enabling-protocomm-security-version:

--- a/docs/zh_CN/api-reference/provisioning/provisioning.rst
+++ b/docs/zh_CN/api-reference/provisioning/provisioning.rst
@@ -1,5 +1,3 @@
-:orphan:
-
 统一配网
 ^^^^^^^^^^^^^^^^^^^^

--- a/docs/zh_CN/api-reference/provisioning/wifi_provisioning.rst
+++ b/docs/zh_CN/api-reference/provisioning/wifi_provisioning.rst
@@ -1,5 +1,3 @@
-:orphan:
-
 Wi-Fi 配网
 ====================

--- a/docs/zh_CN/security/security.rst
+++ b/docs/zh_CN/security/security.rst
@@ -197,6 +197,8 @@ UART 下载模式
 产品安全
 ----------------

+.. only:: SOC_WIFI_SUPPORTED
+
    安全配网
    ~~~~~~~~~~~~~~~~~~~