docs: Updated CN translation for index files in api-guides and api-reference

This commit is contained in:
Shang Zhou
2021-12-30 18:50:55 +08:00
parent 46d5f92533
commit 33a00cf197
17 changed files with 295 additions and 234 deletions

View File

@@ -6,13 +6,13 @@ Bluetooth API
.. toctree::
:maxdepth: 2
Bluetooth Controller && VHCI <controller_vhci>
Bluetooth Common <bt_common>
Bluetooth LE <bt_le>
:SOC_CLASSIC_BT_SUPPORTED: Bluetooth Classic <classic_bt>
NimBLE <nimble/index>
ESP-BLE-MESH <esp-ble-mesh>
bt_common
bt_le
:SOC_CLASSIC_BT_SUPPORTED: classic_bt
controller_vhci
esp-ble-mesh
nimble/index
ESP-IDF currently supports two host stacks. The Bluedroid based stack (default) supports classic Bluetooth as well as BLE. On the other hand, Apache NimBLE based stack is BLE only. For users to make a choice:
* For usecases involving classic Bluetooth as well as BLE, Bluedroid should be used.
@@ -22,8 +22,7 @@ ESP-IDF currently supports two host stacks. The Bluedroid based stack (default)
For the overview of the ESP32 Bluetooth stack architecture, follow the links below:
* `ESP32 Bluetooth Architecture (PDF) [English] <http://espressif.com/sites/default/files/documentation/esp32_bluetooth_architecture_en.pdf>`_
* `ESP32 Bluetooth Architecture (PDF) [中文] <http://espressif.com/sites/default/files/documentation/esp32_bluetooth_architecture_cn.pdf>`_
* `ESP32 Bluetooth Architecture (PDF) <http://espressif.com/sites/default/files/documentation/esp32_bluetooth_architecture_en.pdf>`_
Code examples for this API section are provided in the :example:`bluetooth/bluedroid` directory of ESP-IDF examples.

View File

@@ -4,15 +4,15 @@ API Reference
:link_to_translation:`zh_CN:[中文]`
.. toctree::
:maxdepth: 2
:maxdepth: 2
:SOC_BT_SUPPORTED: Bluetooth <bluetooth/index>
Networking <network/index>
Peripherals <peripherals/index>
Protocols <protocols/index>
Provisioning <provisioning/index>
Storage <storage/index>
System <system/index>
API Conventions <api-conventions>
Configuration Options <kconfig>
Error Codes Reference <error-codes>
api-conventions
protocols/index
:SOC_BT_SUPPORTED: bluetooth/index
error-codes
network/index
peripherals/index
kconfig
provisioning/index
storage/index
system/index

View File

@@ -9,11 +9,11 @@ Wi-Fi
.. toctree::
:maxdepth: 1
Wi-Fi <esp_wifi>
SmartConfig <esp_smartconfig>
ESP-NOW <esp_now>
ESP-WIFI-MESH <esp-wifi-mesh>
EasyConnect <esp_dpp>
esp_now
esp-wifi-mesh
esp_smartconfig
esp_wifi
esp_dpp
Code examples for the Wi-Fi API are provided in the :example:`wifi` directory of ESP-IDF examples.
@@ -26,7 +26,7 @@ Ethernet
.. toctree::
:maxdepth: 1
Ethernet <esp_eth>
esp_eth
Code examples for the Ethernet API are provided in the :example:`ethernet` directory of ESP-IDF examples.
@@ -36,7 +36,7 @@ Thread
.. toctree::
:maxdepth: 1
Thread <esp_openthread>
esp_openthread
Thread is an IPv6-based mesh networking technology for IoT.
Code examples for the Thread API are provided in the :example:`openthread` directory of ESP-IDF examples.
@@ -47,7 +47,7 @@ ESP-NETIF
.. toctree::
:maxdepth: 1
ESP-NETIF <esp_netif.rst>
esp_netif
IP Network Layer
================
@@ -55,13 +55,12 @@ IP Network Layer
.. toctree::
:hidden:
TCP/IP Adapter Migration Guide <tcpip_adapter_migration.rst>
ESP-NETIF Custom I/O Driver <esp_netif_driver.rst>
tcpip_adapter_migration
esp_netif_driver
Code examples for TCP/IP socket APIs are provided in the :example:`protocols/sockets` directory of ESP-IDF examples.
The TCP/IP Adapter (legacy network interface library) has been deprecated, please consult the :doc:`/api-reference/network/tcpip_adapter_migration`
to update existing IDF applications.
The TCP/IP Adapter (legacy network interface library) has been deprecated, please consult the :doc:`/api-reference/network/tcpip_adapter_migration` to update existing IDF applications.
Application Layer 
=================

View File

@@ -5,21 +5,21 @@ Application Protocols
.. toctree::
:maxdepth: 1
ASIO <asio>
ESP-MQTT <mqtt>
ESP-TLS <esp_tls>
OpenSSL APIs <openssl_apis>
HTTP Client <esp_http_client>
HTTP Server <esp_http_server>
HTTPS Server <esp_https_server>
ICMP Echo <icmp_echo>
Local Control <esp_local_ctrl>
mDNS <mdns>
Modbus <modbus>
Websocket Client <esp_websocket_client>
ESP Serial Slave Link <esp_serial_slave_link>
Certificate Bundle <esp_crt_bundle>
asio
modbus
mqtt
esp_tls
esp_http_client
esp_local_ctrl
esp_serial_slave_link
esp_websocket_client
esp_crt_bundle
esp_http_server
esp_https_server
icmp_echo
mdns
openssl_apis
Code examples for this API section are provided in the :example:`protocols` directory of ESP-IDF examples.

View File

@@ -6,22 +6,22 @@ Provisioning API
.. toctree::
:maxdepth: 1
Protocol Communication <protocomm>
Unified Provisioning <provisioning>
Wi-Fi Provisioning <wifi_provisioning>
protocomm
provisioning
wifi_provisioning
Code examples for above API are provided in the :example:`provisioning` directory of ESP-IDF examples.
.. toctree::
:maxdepth: 1
SmartConfig <../network/esp_smartconfig>
../network/esp_smartconfig
Code example for above API is provided in :example:`wifi/smart_config`
Code example for above API is provided in :example:`wifi/smart_config`.
.. toctree::
:maxdepth: 1
EasyConnect <../network/esp_dpp>
../network/esp_dpp
Code example for above API is provided in :example:`wifi/wifi_easy_connect/dpp-enrollee`
Code example for above API is provided in :example:`wifi/wifi_easy_connect/dpp-enrollee`.

View File

@@ -6,15 +6,15 @@ Storage API
.. toctree::
:maxdepth: 1
FAT Filesystem <fatfs>
Mass Manufacturing Utility <mass_mfg.rst>
Non-Volatile Storage <nvs_flash>
NVS Partition Generation Utility <nvs_partition_gen.rst>
SD/SDIO/MMC Driver <sdmmc>
SPI Flash and Partition APIs <spi_flash>
SPIFFS Filesystem <spiffs>
Virtual Filesystem <vfs>
Wear Levelling API <wear-levelling>
fatfs
mass_mfg.rst
nvs_flash
nvs_partition_gen.rst
sdmmc
spi_flash
spiffs
vfs
wear-levelling

View File

@@ -1,37 +1,39 @@
System API
**********
:link_to_translation:`zh_CN:[中文]`
.. toctree::
:maxdepth: 1
App image format <app_image_format>
Application Level Tracing <app_trace>
:SOC_ASYNC_MEMCPY_SUPPORTED: Async Memory Copy <async_memcpy>
Console Component <console>
eFuse Manager <efuse>
Error Codes and Helper Functions <esp_err>
ESP HTTPS OTA <esp_https_ota>
POSIX Threads Support <pthread>
Event Loop Library <esp_event>
FreeRTOS <freertos>
FreeRTOS Supplemental Features <freertos_additions>
Heap Memory Allocation <mem_alloc>
Heap Memory Debugging <heap_debug>
High Resolution Timer <esp_timer>
:esp32: Himem (large external SPI RAM) API <himem>
:not CONFIG_FREERTOS_UNICORE: Inter-Processor Call <ipc>
Call function with external stack <esp_function_with_shared_stack>
Interrupt Allocation <intr_alloc>
Logging <log>
Miscellaneous System APIs <system>
Over The Air Updates (OTA) <ota>
:CONFIG_IDF_TARGET_ARCH_XTENSA: Performance Monitor <perfmon>
Power Management <power_management>
Random Number Generation <random>
Sleep Modes <sleep_modes>
Watchdogs <wdts>
System Time <system_time>
Internal and Unstable API <internal-unstable>
app_image_format
app_trace
esp_function_with_shared_stack
console
efuse
esp_err
esp_https_ota
esp_event
freertos
freertos_additions
mem_alloc
heap_debug
esp_timer
internal-unstable
:not CONFIG_FREERTOS_UNICORE: ipc
intr_alloc
log
system
ota
:CONFIG_IDF_TARGET_ARCH_XTENSA: perfmon
power_management
pthread
random
sleep_modes
system_time
:SOC_ASYNC_MEMCPY_SUPPORTED: async_memcpy
:esp32: himem
wdts
Code examples for this API section are provided in the :example:`system` directory of ESP-IDF examples.