From f675334ebb95868cb4a994fabdc450a9a4fb6f66 Mon Sep 17 00:00:00 2001 From: krzychb Date: Sun, 27 Jan 2019 19:01:34 +0100 Subject: [PATCH] Included missing links between English and Chinese documentation, where translation into Chinese is available --- docs/en/api-guides/blufi.rst | 1 + docs/en/api-guides/build-system.rst | 1 + docs/en/api-guides/console.rst | 1 + docs/en/api-guides/error-handling.rst | 1 + docs/en/api-guides/general-notes.rst | 1 + docs/en/api-guides/index.rst | 1 + docs/en/api-guides/partition-tables.rst | 1 + docs/en/api-guides/unit-tests-cmake.rst | 1 + docs/en/api-guides/unit-tests.rst | 1 + docs/en/contribute/creating-examples.rst | 1 + docs/en/get-started/linux-setup-scratch.rst | 1 + docs/en/get-started/macos-setup-scratch.rst | 1 + docs/en/hw-reference/index.rst | 1 + docs/en/resources.rst | 1 + docs/zh_CN/api-guides/blufi.rst | 1 + docs/zh_CN/api-guides/build-system.rst | 1 + docs/zh_CN/api-guides/console.rst | 1 + docs/zh_CN/api-guides/error-handling.rst | 1 + docs/zh_CN/api-guides/general-notes.rst | 1 + docs/zh_CN/api-guides/index.rst | 1 + docs/zh_CN/api-guides/partition-tables.rst | 1 + docs/zh_CN/api-guides/unit-tests-cmake.rst | 1 + docs/zh_CN/api-guides/unit-tests.rst | 1 + docs/zh_CN/contribute/creating-examples.rst | 1 + docs/zh_CN/get-started/linux-setup-scratch.rst | 1 + docs/zh_CN/get-started/macos-setup-scratch.rst | 1 + docs/zh_CN/hw-reference/index.rst | 1 + docs/zh_CN/resources.rst | 1 + 28 files changed, 28 insertions(+) diff --git a/docs/en/api-guides/blufi.rst b/docs/en/api-guides/blufi.rst index 96a196ba60..61b8a03dfa 100644 --- a/docs/en/api-guides/blufi.rst +++ b/docs/en/api-guides/blufi.rst @@ -1,5 +1,6 @@ BluFi ^^^^^ +:link_to_translation:`zh_CN:[中文]` Overview -------- diff --git a/docs/en/api-guides/build-system.rst b/docs/en/api-guides/build-system.rst index a489d5e456..8f6a98be0e 100644 --- a/docs/en/api-guides/build-system.rst +++ b/docs/en/api-guides/build-system.rst @@ -1,5 +1,6 @@ Build System ************ +:link_to_translation:`zh_CN:[中文]` This document explains the Espressif IoT Development Framework build system and the concept of "components" diff --git a/docs/en/api-guides/console.rst b/docs/en/api-guides/console.rst index 1b9d56fe3b..5119d3ae2f 100644 --- a/docs/en/api-guides/console.rst +++ b/docs/en/api-guides/console.rst @@ -1,5 +1,6 @@ Console ======= +:link_to_translation:`zh_CN:[中文]` ESP-IDF provides ``console`` component, which includes building blocks needed to develop an interactive console over serial port. This component includes following facilities: diff --git a/docs/en/api-guides/error-handling.rst b/docs/en/api-guides/error-handling.rst index b7d49e7655..ed65d5fc7f 100644 --- a/docs/en/api-guides/error-handling.rst +++ b/docs/en/api-guides/error-handling.rst @@ -2,6 +2,7 @@ Error Handling ============== +:link_to_translation:`zh_CN:[中文]` Overview -------- diff --git a/docs/en/api-guides/general-notes.rst b/docs/en/api-guides/general-notes.rst index 71ae1eff4a..b3860332fb 100644 --- a/docs/en/api-guides/general-notes.rst +++ b/docs/en/api-guides/general-notes.rst @@ -1,5 +1,6 @@ General Notes About ESP-IDF Programming ======================================= +:link_to_translation:`zh_CN:[中文]` Application startup flow ------------------------ diff --git a/docs/en/api-guides/index.rst b/docs/en/api-guides/index.rst index 7302fbee4e..17be4f178e 100644 --- a/docs/en/api-guides/index.rst +++ b/docs/en/api-guides/index.rst @@ -1,5 +1,6 @@ API Guides ********** +:link_to_translation:`zh_CN:[中文]` .. toctree:: :maxdepth: 1 diff --git a/docs/en/api-guides/partition-tables.rst b/docs/en/api-guides/partition-tables.rst index 0288fb8c41..502c7118c9 100644 --- a/docs/en/api-guides/partition-tables.rst +++ b/docs/en/api-guides/partition-tables.rst @@ -1,5 +1,6 @@ Partition Tables ================ +:link_to_translation:`zh_CN:[中文]` Overview -------- diff --git a/docs/en/api-guides/unit-tests-cmake.rst b/docs/en/api-guides/unit-tests-cmake.rst index 05a5bf3436..6668963424 100644 --- a/docs/en/api-guides/unit-tests-cmake.rst +++ b/docs/en/api-guides/unit-tests-cmake.rst @@ -1,5 +1,6 @@ Unit Testing in ESP32 (CMake) ============================= +:link_to_translation:`zh_CN:[中文]` .. include:: ../cmake-warning.rst diff --git a/docs/en/api-guides/unit-tests.rst b/docs/en/api-guides/unit-tests.rst index 577bdd5881..43346e4b41 100644 --- a/docs/en/api-guides/unit-tests.rst +++ b/docs/en/api-guides/unit-tests.rst @@ -1,5 +1,6 @@ Unit Testing in ESP32 ===================== +:link_to_translation:`zh_CN:[中文]` ESP-IDF comes with a unit test app based on Unity - unit test framework. Unit tests are integrated in the ESP-IDF repository and are placed in ``test`` subdirectory of each component respectively. diff --git a/docs/en/contribute/creating-examples.rst b/docs/en/contribute/creating-examples.rst index 0904d3e431..4750fb9116 100644 --- a/docs/en/contribute/creating-examples.rst +++ b/docs/en/contribute/creating-examples.rst @@ -1,5 +1,6 @@ Creating Examples ================= +:link_to_translation:`zh_CN:[中文]` Each ESP-IDF example is a complete project that someone else can copy and adapt the code to solve their own problem. Examples should demonstrate ESP-IDF functionality, while keeping this purpose in mind. diff --git a/docs/en/get-started/linux-setup-scratch.rst b/docs/en/get-started/linux-setup-scratch.rst index cf6efa3739..5462ca025a 100644 --- a/docs/en/get-started/linux-setup-scratch.rst +++ b/docs/en/get-started/linux-setup-scratch.rst @@ -1,6 +1,7 @@ ********************************** Setup Linux Toolchain from Scratch ********************************** +:link_to_translation:`zh_CN:[中文]` .. note:: diff --git a/docs/en/get-started/macos-setup-scratch.rst b/docs/en/get-started/macos-setup-scratch.rst index 0cf8130bf3..a4dfe9d7f1 100644 --- a/docs/en/get-started/macos-setup-scratch.rst +++ b/docs/en/get-started/macos-setup-scratch.rst @@ -1,6 +1,7 @@ *************************************** Setup Toolchain for Mac OS from Scratch *************************************** +:link_to_translation:`zh_CN:[中文]` .. note:: diff --git a/docs/en/hw-reference/index.rst b/docs/en/hw-reference/index.rst index 288ccc2a18..dafafa2129 100644 --- a/docs/en/hw-reference/index.rst +++ b/docs/en/hw-reference/index.rst @@ -1,6 +1,7 @@ ************************ ESP32 Hardware Reference ************************ +:link_to_translation:`zh_CN:[中文]` .. toctree:: :maxdepth: 2 diff --git a/docs/en/resources.rst b/docs/en/resources.rst index 6707c0d491..20d6a77054 100644 --- a/docs/en/resources.rst +++ b/docs/en/resources.rst @@ -1,6 +1,7 @@ ********* Resources ********* +:link_to_translation:`zh_CN:[中文]` * The `esp32.com forum `_ is a place to ask questions and find community resources. diff --git a/docs/zh_CN/api-guides/blufi.rst b/docs/zh_CN/api-guides/blufi.rst index 043b24e577..667aca7514 100644 --- a/docs/zh_CN/api-guides/blufi.rst +++ b/docs/zh_CN/api-guides/blufi.rst @@ -1,5 +1,6 @@ BluFi ^^^^^ +:link_to_translation:`en:[English]` 概览 ----- diff --git a/docs/zh_CN/api-guides/build-system.rst b/docs/zh_CN/api-guides/build-system.rst index 94b8d921e6..a677f3a28f 100644 --- a/docs/zh_CN/api-guides/build-system.rst +++ b/docs/zh_CN/api-guides/build-system.rst @@ -1,5 +1,6 @@ 编译系统 ======== +:link_to_translation:`en:[English]` 本文将介绍乐鑫物联网开发框架中的``编译系统``和``组件``的相关概念。 diff --git a/docs/zh_CN/api-guides/console.rst b/docs/zh_CN/api-guides/console.rst index 0af8aa948d..c7a6408acd 100644 --- a/docs/zh_CN/api-guides/console.rst +++ b/docs/zh_CN/api-guides/console.rst @@ -1,5 +1,6 @@ 控制台终端 ========== +:link_to_translation:`en:[English]` ESP-IDF 提供了 ``console`` 组件，它包含了开发基于串口的交互式控制终端所需要的所有模块，主要支持以下功能： diff --git a/docs/zh_CN/api-guides/error-handling.rst b/docs/zh_CN/api-guides/error-handling.rst index eb50b458ac..22e1ff8952 100644 --- a/docs/zh_CN/api-guides/error-handling.rst +++ b/docs/zh_CN/api-guides/error-handling.rst @@ -2,6 +2,7 @@ 错误处理 ======== +:link_to_translation:`en:[English]` 概述 ---- diff --git a/docs/zh_CN/api-guides/general-notes.rst b/docs/zh_CN/api-guides/general-notes.rst index 8a497e3b8c..320ed2a91b 100644 --- a/docs/zh_CN/api-guides/general-notes.rst +++ b/docs/zh_CN/api-guides/general-notes.rst @@ -1,5 +1,6 @@ ESP-IDF 编程注意事项 ====================== +:link_to_translation:`en:[English]` 应用程序的启动流程 ------------------ diff --git a/docs/zh_CN/api-guides/index.rst b/docs/zh_CN/api-guides/index.rst index fcb76cc63c..2c2eae64f9 100644 --- a/docs/zh_CN/api-guides/index.rst +++ b/docs/zh_CN/api-guides/index.rst @@ -1,5 +1,6 @@ API 指南 ********** +:link_to_translation:`en:[English]` .. toctree:: :maxdepth: 1 diff --git a/docs/zh_CN/api-guides/partition-tables.rst b/docs/zh_CN/api-guides/partition-tables.rst index d06f8ece43..deff7c14c8 100644 --- a/docs/zh_CN/api-guides/partition-tables.rst +++ b/docs/zh_CN/api-guides/partition-tables.rst @@ -1,5 +1,6 @@ 分区表 ====== +:link_to_translation:`en:[English]` 概述 ---- diff --git a/docs/zh_CN/api-guides/unit-tests-cmake.rst b/docs/zh_CN/api-guides/unit-tests-cmake.rst index dfd4fb6d7f..c5f8898b7d 100644 --- a/docs/zh_CN/api-guides/unit-tests-cmake.rst +++ b/docs/zh_CN/api-guides/unit-tests-cmake.rst @@ -1,5 +1,6 @@ ESP32 中的单元测试 (CMake) ========================== +:link_to_translation:`en:[English]` ESP-IDF 中附带了一个基于 ``Unity`` 的单元测试应用程序框架，且所有的单元测试用例分别保存在 diff --git a/docs/zh_CN/api-guides/unit-tests.rst b/docs/zh_CN/api-guides/unit-tests.rst index 7924fc6beb..de8e52d3ef 100644 --- a/docs/zh_CN/api-guides/unit-tests.rst +++ b/docs/zh_CN/api-guides/unit-tests.rst @@ -1,5 +1,6 @@ ESP32 中的单元测试 ================== +:link_to_translation:`en:[English]` ESP-IDF 中附带了一个基于 ``Unity`` 的单元测试应用程序框架，且所有的单元测试用例分别保存在 diff --git a/docs/zh_CN/contribute/creating-examples.rst b/docs/zh_CN/contribute/creating-examples.rst index fa9ad0fca0..84ab791462 100644 --- a/docs/zh_CN/contribute/creating-examples.rst +++ b/docs/zh_CN/contribute/creating-examples.rst @@ -1,5 +1,6 @@ 创建示例项目 ============ +:link_to_translation:`en:[English]` 每个 ESP-IDF 的示例都是一个完整的项目，其他人可以将示例复制至本地，并根据实际情况进行一定修改。请注意，示例项目主要是为了展示 ESP-IDF 的功能。 diff --git a/docs/zh_CN/get-started/linux-setup-scratch.rst b/docs/zh_CN/get-started/linux-setup-scratch.rst index afeafa8521..ca3dbcebb4 100644 --- a/docs/zh_CN/get-started/linux-setup-scratch.rst +++ b/docs/zh_CN/get-started/linux-setup-scratch.rst @@ -1,6 +1,7 @@ ********************************** 从零开始设置 Linux 环境下的工具链 ********************************** +:link_to_translation:`en:[English]` .. note:: diff --git a/docs/zh_CN/get-started/macos-setup-scratch.rst b/docs/zh_CN/get-started/macos-setup-scratch.rst index 0b2d238092..1588c80c86 100644 --- a/docs/zh_CN/get-started/macos-setup-scratch.rst +++ b/docs/zh_CN/get-started/macos-setup-scratch.rst @@ -1,6 +1,7 @@ ********************************** 从零开始设置 Mac OS 环境下的工具链 ********************************** +:link_to_translation:`en:[English]` .. note:: diff --git a/docs/zh_CN/hw-reference/index.rst b/docs/zh_CN/hw-reference/index.rst index cbd034fd13..f65e95a6c3 100644 --- a/docs/zh_CN/hw-reference/index.rst +++ b/docs/zh_CN/hw-reference/index.rst @@ -1,6 +1,7 @@ ************************ ESP32 H/W 硬件参考 ************************ +:link_to_translation:`en:[English]` .. toctree:: :maxdepth: 2 diff --git a/docs/zh_CN/resources.rst b/docs/zh_CN/resources.rst index 2a342cdd43..a02507e5e6 100644 --- a/docs/zh_CN/resources.rst +++ b/docs/zh_CN/resources.rst @@ -1,6 +1,7 @@ **** 资源 **** +:link_to_translation:`en:[English]` * 您可以在 `ESP32 论坛 `_ 中提出您的问题，访问社区资源。