Merge branch 'doc/add_translation_for_api-reference_index.rst' into 'master'

Add Chinese translation for index.rst files and esp_wifi.rst file in api-reference following Kirill's English review

See merge request idf/esp-idf!4943

docs/en/api-reference/bluetooth/index.rst

@@ -1,6 +1,8 @@
 Bluetooth API
 *************
 
+:link_to_translation:`zh_CN:[中文]`
+
 .. toctree::
    :maxdepth: 2
 

docs/en/api-reference/network/esp_wifi.rst

@@ -1,6 +1,8 @@
 Wi-Fi
 =====
 
+:link_to_translation:`zh_CN:[中文]`
+
 Introduction
 ------------
 

docs/en/api-reference/network/index.rst

@@ -1,6 +1,8 @@
 Networking APIs
 ***************
 
+:link_to_translation:`zh_CN:[中文]`
+
 Wi-Fi
 =====
 

docs/en/api-reference/peripherals/index.rst

@@ -1,6 +1,8 @@
 Peripherals API
 ***************
 
+:link_to_translation:`zh_CN:[中文]`
+
 .. toctree::
    :maxdepth: 1
 

docs/en/api-reference/provisioning/index.rst

@@ -1,6 +1,8 @@
 Provisioning API
 ****************
 
+:link_to_translation:`zh_CN:[中文]`
+
 .. toctree::
    :maxdepth: 1
 

docs/zh_CN/api-reference/bluetooth/index.rst

@@ -1 +1,29 @@
-.. include:: ../../../en/api-reference/bluetooth/index.rst
+蓝牙 API
+*************
+
+:link_to_translation:`en:[English]`
+
+.. toctree::
+   :maxdepth: 2
+
+   Bluetooth Controller && VHCI <controller_vhci>
+   Bluetooth Common <bt_common>
+   Bluetooth LE <bt_le>
+   Bluetooth Classic <classic_bt>
+
+
+请点击下方链接，查看 ESP32 蓝牙架构：
+
+`ESP32 蓝牙架构 (PDF) <http://espressif.com/sites/default/files/documentation/esp32_bluetooth_architecture_cn.pdf>`_
+
+蓝牙 API 的示例代码存放于 ESP-IDF :example:`bluetooth` 示例目录下，请查看。
+
+下面的示例给出了详细介绍：
+
+* :example_file:`GATT 客户端示例 <bluetooth/gatt_client/tutorial/Gatt_Client_Example_Walkthrough.md>`
+* :example_file:`GATT 服务端服务表格示例 <bluetooth/gatt_server_service_table/tutorial/Gatt_Server_Service_Table_Example_Walkthrough.md>`
+* :example_file:`GATT 服务端示例 <bluetooth/gatt_server/tutorial/Gatt_Server_Example_Walkthrough.md>`
+* :example_file:`GATT 客户端安全性示例 <bluetooth/gatt_security_client/tutorial/Gatt_Security_Client_Example_Walkthrough.md>`
+* :example_file:`GATT 服务端安全性示例 <bluetooth/gatt_security_server/tutorial/Gatt_Security_Server_Example_Walkthrough.md>`
+* :example_file:`GATT 客户端多连接示例 <bluetooth/gattc_multi_connect/tutorial/Gatt_Client_Multi_Connection_Example_Walkthrough.md>`
+

docs/zh_CN/api-reference/network/esp_wifi.rst

@@ -1 +1,36 @@
-.. include:: ../../../en/api-reference/network/esp_wifi.rst
+Wi-Fi 库
+========
+
+:link_to_translation:`en:[English]`
+
+概述
+-----
+
+Wi-Fi 库支持配置及监控 ESP32 Wi-Fi 连网功能。
+
+支持配置：
+
+- 基站模式（即 STA 模式或 Wi-Fi 客户端模式），此时 ESP32 连接到接入点 (AP)。
+- AP 模式（即 Soft-AP 模式或接入点模式），此时基站连接到 ESP32。
+- AP-STA 共存模式（ESP32 既是接入点，同时又作为基站连接到另外一个接入点）。
+
+- 上述模式的各种安全模式（WPA、WPA2 及 WEP 等）。
+- 扫描接入点（包括主动扫描及被动扫描）。
+- 使用混杂模式监控 IEEE802.11 Wi-Fi 数据包。
+
+
+应用示例
+----------
+
+ESP-IDF 示例项目的 :example:`wifi` 目录下包含以下应用程序：
+
+* Wi-Fi 示例代码；
+
+* 另外一个简单的应用程序 `esp-idf-template <https://github.com/espressif/esp-idf-template>`_，演示了如何将 ESP32 模组连接到 AP。
+
+
+API 参考
+-------------
+
+.. include:: /_build/inc/esp_wifi.inc
+.. include:: /_build/inc/esp_wifi_types.inc

docs/zh_CN/api-reference/network/index.rst

@@ -1 +1,47 @@
-.. include:: ../../../en/api-reference/network/index.rst
+连网 API
+***************
+
+:link_to_translation:`en:[English]`
+
+Wi-Fi
+=======
+
+.. toctree::
+   :maxdepth: 1
+
+   Wi-Fi <esp_wifi>
+   Smart Config <esp_smartconfig>
+   ESP-NOW <esp_now>
+   ESP Mesh <esp_mesh>
+
+本部分的 Wi-Fi API 示例代码存放在 ESP-IDF 示例项目的 :example:`wifi` 目录下。
+
+ESP-MESH 的示例代码存放在 ESP-IDF 示例项目的 :example:`mesh` 目录下。
+
+
+以太网
+========
+
+.. toctree::
+   :maxdepth: 1
+
+   Ethernet <esp_eth>
+
+本部分的以太网 API 示例代码存放在 ESP-IDF 示例项目的 :example:`ethernet` 目录下。
+
+
+IP 网络层协议
+================
+
+.. toctree::
+   :maxdepth: 1
+
+   TCP/IP Adapter <tcpip_adapter.rst>
+
+TCP/IP 套接字 API 的示例代码存放在 ESP-IDF 示例项目的 :example:`protocols/sockets` 目录下。
+
+
+应用层协议 
+===========
+
+应用层网络协议（IP 网络层协议之上）的相关文档存放在 :doc:`../protocols/index`。

docs/zh_CN/api-reference/peripherals/index.rst

@@ -1 +1,30 @@
-.. include:: ../../../en/api-reference/peripherals/index.rst
+外设 API
+***************
+
+:link_to_translation:`en:[English]`
+
+.. toctree::
+   :maxdepth: 1
+
+   ADC <adc>
+   CAN <can>
+   DAC <dac>
+   GPIO (including RTC low power I/O) <gpio>
+   I2C <i2c>
+   I2S <i2s>
+   LED Control <ledc>
+   MCPWM <mcpwm>
+   Pulse Counter <pcnt>
+   Remote Control <rmt>
+   SDMMC Host <sdmmc_host>
+   SD SPI Host <sdspi_host>
+   SDIO Slave <sdio_slave>
+   Sigma-delta Modulation <sigmadelta>
+   SPI Master <spi_master>
+   SPI Slave <spi_slave>
+   Timer <timer>
+   Touch Sensor <touch_pad>
+   UART <uart>
+
+本部分的 API 示例代码存放在 ESP-IDF 示例项目的 :example:`peripherals` 目录下。 
+

docs/zh_CN/api-reference/provisioning/index.rst

@@ -1 +1,13 @@
-.. include:: ../../../en/api-reference/provisioning/index.rst
+配网 API
+****************
+
+:link_to_translation:`en:[English]`
+
+.. toctree::
+   :maxdepth: 1
+
+   Unified Provisioning <provisioning>
+   Protocol Communication <protocomm>
+   Wi-Fi Provisioning <wifi_provisioning>
+
+本部分的 API 示例代码存放在 ESP-IDF 示例项目的 :example:`provisioning` 目录下。