From d4deb9319a93329eeef2f3342e48ff3e87a6892e Mon Sep 17 00:00:00 2001 From: michael Date: Fri, 27 Apr 2018 14:46:13 +0800 Subject: [PATCH] doc(global): build cross-language links for translated documents --- docs/en/get-started/add-idf_path-to-profile.rst | 1 + docs/en/get-started/eclipse-setup-windows.rst | 1 + docs/en/get-started/eclipse-setup.rst | 1 + docs/en/get-started/establish-serial-connection.rst | 1 + docs/en/get-started/get-started-pico-kit.rst | 1 + docs/en/get-started/idf-monitor.rst | 1 + docs/en/get-started/index.rst | 1 + docs/en/get-started/linux-setup.rst | 1 + docs/en/get-started/macos-setup.rst | 1 + docs/en/get-started/make-project.rst | 1 + docs/en/get-started/windows-setup.rst | 1 + docs/zh_CN/get-started/add-idf_path-to-profile.rst | 3 ++- docs/zh_CN/get-started/eclipse-setup-windows.rst | 3 ++- docs/zh_CN/get-started/eclipse-setup.rst | 1 + docs/zh_CN/get-started/establish-serial-connection.rst | 1 + docs/zh_CN/get-started/get-started-pico-kit.rst | 3 ++- docs/zh_CN/get-started/idf-monitor.rst | 1 + docs/zh_CN/get-started/index.rst | 1 + docs/zh_CN/get-started/linux-setup.rst | 1 + docs/zh_CN/get-started/macos-setup.rst | 1 + docs/zh_CN/get-started/make-project.rst | 1 + docs/zh_CN/get-started/windows-setup.rst | 1 + 22 files changed, 25 insertions(+), 3 deletions(-) diff --git a/docs/en/get-started/add-idf_path-to-profile.rst b/docs/en/get-started/add-idf_path-to-profile.rst index 60ca43481..8ce9a9ae6 100644 --- a/docs/en/get-started/add-idf_path-to-profile.rst +++ b/docs/en/get-started/add-idf_path-to-profile.rst @@ -1,5 +1,6 @@ Add IDF_PATH to User Profile ============================ +:link_to_translation:`zh_CN:[中文]` To preserve setting of ``IDF_PATH`` environment variable between system restarts, add it to the user profile, following instructions below. diff --git a/docs/en/get-started/eclipse-setup-windows.rst b/docs/en/get-started/eclipse-setup-windows.rst index a924d2dc7..2728eb297 100644 --- a/docs/en/get-started/eclipse-setup-windows.rst +++ b/docs/en/get-started/eclipse-setup-windows.rst @@ -1,6 +1,7 @@ ********************** Eclipse IDE on Windows ********************** +:link_to_translation:`zh_CN:[中文]` Configuring Eclipse on Windows requires some different steps. The full configuration steps for Windows are shown below. diff --git a/docs/en/get-started/eclipse-setup.rst b/docs/en/get-started/eclipse-setup.rst index 9ceb3c779..7d17d6c15 100644 --- a/docs/en/get-started/eclipse-setup.rst +++ b/docs/en/get-started/eclipse-setup.rst @@ -1,6 +1,7 @@ ******************************** Build and Flash with Eclipse IDE ******************************** +:link_to_translation:`zh_CN:[中文]` .. _eclipse-install-steps: diff --git a/docs/en/get-started/establish-serial-connection.rst b/docs/en/get-started/establish-serial-connection.rst index d4c0943a4..e54345d83 100644 --- a/docs/en/get-started/establish-serial-connection.rst +++ b/docs/en/get-started/establish-serial-connection.rst @@ -1,5 +1,6 @@ Establish Serial Connection with ESP32 ====================================== +:link_to_translation:`zh_CN:[中文]` This section provides guidance how to establish serial connection between ESP32 and PC. diff --git a/docs/en/get-started/get-started-pico-kit.rst b/docs/en/get-started/get-started-pico-kit.rst index 831de1ac1..12ff80aed 100644 --- a/docs/en/get-started/get-started-pico-kit.rst +++ b/docs/en/get-started/get-started-pico-kit.rst @@ -1,5 +1,6 @@ ESP32-PICO-KIT V4 Getting Started Guide ======================================= +:link_to_translation:`zh_CN:[中文]` This user guide shows how to get started with the ESP32-PICO-KIT V4 mini development board. For description of other versions of the ESP32-PICO-KIT check :doc:`../hw-reference/index`. diff --git a/docs/en/get-started/idf-monitor.rst b/docs/en/get-started/idf-monitor.rst index cf1deec35..09291a3d3 100644 --- a/docs/en/get-started/idf-monitor.rst +++ b/docs/en/get-started/idf-monitor.rst @@ -1,6 +1,7 @@ *********** IDF Monitor *********** +:link_to_translation:`zh_CN:[中文]` The IDF Monitor tool is a Python program which runs when the ``make monitor`` target is invoked in IDF. diff --git a/docs/en/get-started/index.rst b/docs/en/get-started/index.rst index 9a2d3779c..9e33e6349 100644 --- a/docs/en/get-started/index.rst +++ b/docs/en/get-started/index.rst @@ -1,6 +1,7 @@ *********** Get Started *********** +:link_to_translation:`zh_CN:[中文]` This document is intended to help users set up the software environment for development of applications using hardware based on the Espressif ESP32. Through a simple example we would like to illustrate how to use ESP-IDF (Espressif IoT Development Framework), including the menu based configuration, compiling the ESP-IDF and firmware download to ESP32 boards. diff --git a/docs/en/get-started/linux-setup.rst b/docs/en/get-started/linux-setup.rst index 8004c37ee..bc4102a85 100644 --- a/docs/en/get-started/linux-setup.rst +++ b/docs/en/get-started/linux-setup.rst @@ -1,6 +1,7 @@ ************************************* Standard Setup of Toolchain for Linux ************************************* +:link_to_translation:`zh_CN:[中文]` Install Prerequisites diff --git a/docs/en/get-started/macos-setup.rst b/docs/en/get-started/macos-setup.rst index 14764601b..16123cb03 100644 --- a/docs/en/get-started/macos-setup.rst +++ b/docs/en/get-started/macos-setup.rst @@ -1,6 +1,7 @@ ************************************** Standard Setup of Toolchain for Mac OS ************************************** +:link_to_translation:`zh_CN:[中文]` Install Prerequisites ===================== diff --git a/docs/en/get-started/make-project.rst b/docs/en/get-started/make-project.rst index d85b2a91c..956b097d0 100644 --- a/docs/en/get-started/make-project.rst +++ b/docs/en/get-started/make-project.rst @@ -1,5 +1,6 @@ Build and Flash with Make ========================= +:link_to_translation:`zh_CN:[中文]` Finding a project diff --git a/docs/en/get-started/windows-setup.rst b/docs/en/get-started/windows-setup.rst index e2adebde2..9b143920b 100644 --- a/docs/en/get-started/windows-setup.rst +++ b/docs/en/get-started/windows-setup.rst @@ -1,6 +1,7 @@ *************************************** Standard Setup of Toolchain for Windows *************************************** +:link_to_translation:`zh_CN:[中文]` Introduction ============ diff --git a/docs/zh_CN/get-started/add-idf_path-to-profile.rst b/docs/zh_CN/get-started/add-idf_path-to-profile.rst index 1af406efd..61e8d3dbb 100644 --- a/docs/zh_CN/get-started/add-idf_path-to-profile.rst +++ b/docs/zh_CN/get-started/add-idf_path-to-profile.rst @@ -1,5 +1,6 @@ 在用户配置文件中添加 IDF_PATH ============================== +:link_to_translation:`en:[English]` 为了在系统多次重新启动时保留 “IDF_PATH” 环境变量的设置，请按照以下说明将其添加到用户配置文件中。 @@ -60,4 +61,4 @@ Linux and MacOS export IDF_PATH=~/esp/esp-idf -如果您从 :ref:`get-started-setup-path` 小节跳转到了这里，在安装用于 ESP32 开发的软件时，返回到 :ref:`get-started-start-project` 小节。 \ No newline at end of file +如果您从 :ref:`get-started-setup-path` 小节跳转到了这里，在安装用于 ESP32 开发的软件时，返回到 :ref:`get-started-start-project` 小节。 diff --git a/docs/zh_CN/get-started/eclipse-setup-windows.rst b/docs/zh_CN/get-started/eclipse-setup-windows.rst index ba15bc9db..4047dc939 100644 --- a/docs/zh_CN/get-started/eclipse-setup-windows.rst +++ b/docs/zh_CN/get-started/eclipse-setup-windows.rst @@ -1,6 +1,7 @@ ***************************************************** Eclipse IDE 的创建和烧录指南（Windows 平台） ***************************************************** +:link_to_translation:`en:[English]` Windows 平台上的 Eclipse 配置略有不同，具体步骤请见下文。 @@ -78,4 +79,4 @@ Windows 平台的 Eclipse 介绍到此结束，下方将主要将介绍一些关 * 首先，xtensa-esp32-elf-gcc 交叉编译器 *并非* Cygwin 工具链，但我们会在 Eclipse 中指定其为 Cygwin 工具链。主要原因在于：msys2 需要使用 Cygwin，并支持 Unix 风格的路径，即 ``/c/blah``，而非 ``c:/blah`` 或 ``c:\\blah``。特别需要说明的是，``xtensa-esp32-elf-gcc`` 会“告知” Eclipse 的 ``built-in compiler settings`` 功能，其内置 “include” 目录全部位于 ``/usr/`` 路径下，这也是 Eclipse 唯一可以解析的 ``Unix/Cygwin`` 风格路径。通过在 Eclipse 中指定 ``xtensa-esp32-elf-gcc`` 交叉编译器为 Cygwin 编译器，可以让 Eclipse 使用 cygpath 实用程序直接内部解析路径。 -* 在解析 ESP-IDF 的 make 结果时也经常会出现同样的问题。Eclipse 可以解析 make 的结果，查找头文件目录，但是无法脱离 ``cygpath``，直接解析类似 ``/c/blah`` 的目录。``Eclipse Build Output Parser`` 将利用该机制确认是否调用 ``cygpath``，但由于未知原因，目前 ESP-IDF 配置并不会触发该功能。出于这个原因，我们会使用 ``eclipse_make.py`` 包装脚本调用 ``make``，然后使用 ``cygpath`` 处理 Eclipse 的结果。 \ No newline at end of file +* 在解析 ESP-IDF 的 make 结果时也经常会出现同样的问题。Eclipse 可以解析 make 的结果，查找头文件目录，但是无法脱离 ``cygpath``，直接解析类似 ``/c/blah`` 的目录。``Eclipse Build Output Parser`` 将利用该机制确认是否调用 ``cygpath``，但由于未知原因，目前 ESP-IDF 配置并不会触发该功能。出于这个原因，我们会使用 ``eclipse_make.py`` 包装脚本调用 ``make``，然后使用 ``cygpath`` 处理 Eclipse 的结果。 diff --git a/docs/zh_CN/get-started/eclipse-setup.rst b/docs/zh_CN/get-started/eclipse-setup.rst index 8db863942..e2f7be8a3 100644 --- a/docs/zh_CN/get-started/eclipse-setup.rst +++ b/docs/zh_CN/get-started/eclipse-setup.rst @@ -1,6 +1,7 @@ **************************** Eclipse IDE 的创建和烧录指南 **************************** +:link_to_translation:`en:[English]` .. _eclipse-install-steps: diff --git a/docs/zh_CN/get-started/establish-serial-connection.rst b/docs/zh_CN/get-started/establish-serial-connection.rst index 38c05344c..f934dba3d 100644 --- a/docs/zh_CN/get-started/establish-serial-connection.rst +++ b/docs/zh_CN/get-started/establish-serial-connection.rst @@ -1,5 +1,6 @@ 与 ESP32 创建串口连接 ========================= +:link_to_translation:`en:[English]` 本章节介绍如何在 ESP32 和 PC 之间建立串口连接。 diff --git a/docs/zh_CN/get-started/get-started-pico-kit.rst b/docs/zh_CN/get-started/get-started-pico-kit.rst index d2e44c905..4ffa78dbc 100644 --- a/docs/zh_CN/get-started/get-started-pico-kit.rst +++ b/docs/zh_CN/get-started/get-started-pico-kit.rst @@ -1,5 +1,6 @@ ESP32-PICO-KIT V4 入门指南 ============================ +:link_to_translation:`en:[English]` 本指南介绍了如何开始使用 ESP32-PICO-KIT V4 迷你开发板。有关 ESP32-PICO-KIT 其他版本的介绍，请见 :doc:`../hw-reference/index`。 @@ -216,4 +217,4 @@ Header J3 .. toctree:: :hidden: - get-started-pico-kit-v3 \ No newline at end of file + get-started-pico-kit-v3 diff --git a/docs/zh_CN/get-started/idf-monitor.rst b/docs/zh_CN/get-started/idf-monitor.rst index 5e19ff158..a5b30e2d0 100644 --- a/docs/zh_CN/get-started/idf-monitor.rst +++ b/docs/zh_CN/get-started/idf-monitor.rst @@ -1,6 +1,7 @@ *********** IDF Monitor *********** +:link_to_translation:`en:[English]` IDF Monitor 工具是在 IDF 中调用 “make monitor” 目标时运行的 Python 程序。 diff --git a/docs/zh_CN/get-started/index.rst b/docs/zh_CN/get-started/index.rst index e2eb3d2ea..8831d86fd 100644 --- a/docs/zh_CN/get-started/index.rst +++ b/docs/zh_CN/get-started/index.rst @@ -1,6 +1,7 @@ *********** 快速入门 *********** +:link_to_translation:`en:[English]` 本文档旨在指导用户创建 ESP32 的软件环境。本文将通过一个简单的例子来说明如何使用 ESP-IDF (Espressif IoT Development Framework)，包括配置、编译、下载固件到开发板等步骤。 diff --git a/docs/zh_CN/get-started/linux-setup.rst b/docs/zh_CN/get-started/linux-setup.rst index a4dc1d943..8c5c0cf6b 100644 --- a/docs/zh_CN/get-started/linux-setup.rst +++ b/docs/zh_CN/get-started/linux-setup.rst @@ -1,6 +1,7 @@ ***************************** Linux 平台工具链的标准设置 ***************************** +:link_to_translation:`en:[English]` 安装前提 ===================== diff --git a/docs/zh_CN/get-started/macos-setup.rst b/docs/zh_CN/get-started/macos-setup.rst index ea5b6c60d..18c325303 100644 --- a/docs/zh_CN/get-started/macos-setup.rst +++ b/docs/zh_CN/get-started/macos-setup.rst @@ -1,6 +1,7 @@ ************************************** 在 Mac OS 上安装 ESP32 工具链 ************************************** +:link_to_translation:`en:[English]` 安装准备 ================ diff --git a/docs/zh_CN/get-started/make-project.rst b/docs/zh_CN/get-started/make-project.rst index 6c03bab97..6456d8ef0 100644 --- a/docs/zh_CN/get-started/make-project.rst +++ b/docs/zh_CN/get-started/make-project.rst @@ -1,5 +1,6 @@ 通过 make 指令创建和烧录项目 ============================= +:link_to_translation:`en:[English]` 寻找项目 diff --git a/docs/zh_CN/get-started/windows-setup.rst b/docs/zh_CN/get-started/windows-setup.rst index d83408e3c..8482b5d9c 100644 --- a/docs/zh_CN/get-started/windows-setup.rst +++ b/docs/zh_CN/get-started/windows-setup.rst @@ -1,6 +1,7 @@ *************************************** Windows 平台工具链的标准设置 *************************************** +:link_to_translation:`en:[English]` 引言 ============