Browse Source

docs: Update description for Eclipse+Cmake support not ready yet

Angus Gratton 6 years ago
parent
commit
05ac8cfb6d

+ 1 - 1
docs/en/api-guides/jtag-debugging/configure-wrover.rst

@@ -8,7 +8,7 @@ All versions of ESP-WROVER-KIT boards have built-in JTAG functionality. Putting
 Configure Hardware
 ^^^^^^^^^^^^^^^^^^
 
-1.  Enable on-board JTAG functionality by setting JP8 according to :doc:`../../hw-reference/get-started-wrover-kit`, Section :ref:`get-started-esp-wrover-kit-v4.1-setup-options-cmake`. 
+1.  Enable on-board JTAG functionality by setting JP8 according to :doc:`../../hw-reference/get-started-wrover-kit`, Section :ref:`get-started-esp-wrover-kit-v4.1-setup-options`. 
 
 2.  Verify if ESP32 pins used for JTAG communication are not connected to some other h/w that may disturb JTAG operation:
 

+ 1 - 1
docs/en/api-guides/jtag-debugging/tips-and-quirks.rst

@@ -58,7 +58,7 @@ ESP-IDF has some support options for OpenOCD debugging which can be set at compi
 * :ref:`CONFIG_ESP32_DEBUG_OCDAWARE` is enabled by default. If a panic or unhandled exception is thrown and a JTAG debugger is connected (ie  OpenOCD is running), ESP-IDF will break into the debugger.
 * :ref:`CONFIG_FREERTOS_WATCHPOINT_END_OF_STACK` (disabled by default) sets watchpoint index 1 (the second of two) at the end of any task stack. This is the most accurate way to debug task stack overflows. Click the link for more details.
 
-Please see the :ref:`make menuconfig <get-started-configure>` menu for more details on setting compile-time options.
+Please see the :ref:`project configuration menu <get-started-configure>` menu for more details on setting compile-time options.
 
 .. _jtag-debugging-tip-freertos-support:
 

+ 7 - 4
docs/en/get-started/eclipse-setup.rst

@@ -1,9 +1,12 @@
-****************************************
+********************************
 Build and Flash with Eclipse IDE
-****************************************
-
+********************************
 :link_to_translation:`zh_CN:[中文]`
 
-Documentation for Eclipse setup with CMake-based build system and Eclipse CDT is coming soon.
+ESP-IDF V4.0 will be released with a new CMake-based build system as the default build system.
+
+Eclipse CDT IDE support for CMake-based build system will be available before the ESP-IDF V4.0 release but
+is not available yet. We apologise for the inconvenience.
 
 If you require Eclipse IDE support for this pre-release version of ESP-IDF, you can follow the :doc:`legacy GNU Make build system Getting Started guide </get-started-legacy/index>` which has steps for :doc:`Building and Flashing with Eclipse IDE </get-started-legacy/eclipse-setup>`.
+

+ 1 - 3
docs/en/hw-reference/get-started-ethernet-kit.rst

@@ -348,9 +348,7 @@ Initial Setup
 Now to Development
 ^^^^^^^^^^^^^^^^^^
 
-Proceed to :doc:`../get-started-cmake/index`, where Section :ref:`get-started-step-by-step-cmake` will quickly help you set up the development environment and then flash an example project onto your board.
-
-If you prefer using an older GNU Make build system, then proceed to respective :ref:`get-started-step-by-step` for the GNU Make.
+Proceed to :doc:`../get-started/index`, where Section :ref:`get-started-step-by-step` will quickly help you set up the development environment and then flash an example project onto your board.
 
 Move on to the next section only if you have successfully completed all the above steps.
 

+ 1 - 1
docs/page_redirects.txt

@@ -46,7 +46,7 @@ get-started-cmake/get-started-wrover-kit-v3    hw-reference/get-started-wrover-k
 get-started-cmake/get-started-pico-kit         hw-reference/get-started-pico-kit
 get-started-cmake/get-started-pico-kit-v3      hw-reference/get-started-pico-kit-v3
 
-
 api-guide/build-system-cmake                   api-guide/build-system
 api-guide/ulp-cmake                            api-guide/ulp
+api-guide/unit-tests-cmake                     api-guide/unit-tests
 

+ 1 - 1
docs/zh_CN/api-guides/jtag-debugging/configure-wrover.rst

@@ -8,7 +8,7 @@
 配置硬件
 ^^^^^^^^
 
-1.  根据 :doc:`../../hw-reference/get-started-wrover-kit` 文档中 :ref:`get-started-esp-wrover-kit-v4.1-setup-options-cmake` 章节所描述的信息,设置 JP8 便可以启用 JTAG 功能。 
+1.  根据 :doc:`../../hw-reference/get-started-wrover-kit` 文档中 :ref:`get-started-esp-wrover-kit-v4.1-setup-options` 章节所描述的信息,设置 JP8 便可以启用 JTAG 功能。 
 
 2.  检查 ESP32 上用于 JTAG 通信的引脚是否被接到了其它硬件上,这可能会影响 JTAG 的工作。
 

+ 3 - 5
docs/zh_CN/hw-reference/get-started-devkitc-v2.rst

@@ -9,7 +9,7 @@ ESP32-DevKitC V2 入门指南
 准备工作
 --------
 
-* :ref:`ESP32-DevKitC V2 开发板 <get-started-esp32-devkitc-v2-board-front-cmake>`
+* :ref:`ESP32-DevKitC V2 开发板 <get-started-esp32-devkitc-v2-board-front>`
 * USB A / micro USB B 数据线
 * PC(Windows、Linux 或 Mac OS)
 
@@ -27,7 +27,7 @@ ESP32-DevKitC V2 是 `乐鑫 <https://espressif.com>`_ 一款基于 ESP32 的小
 
 ESP32-DevKitC V2 开发板的主要组件、接口及控制方式见下。
 
-.. _get-started-esp32-devkitc-v2-board-front-cmake:
+.. _get-started-esp32-devkitc-v2-board-front:
 
 .. figure:: ../../_static/esp32-devkitc-v2-functional-overview.png
     :align: center
@@ -71,9 +71,7 @@ ESP32-DevKitC V2 开发板
 
 ESP32-DevKitC V2 上电前,请首先确认开发板完好无损。
 
-之后,请前往 :doc:`../get-started-cmake/index` 中的 :ref:`get-started-step-by-step-cmake` 章节,查看如何设置开发环境,并尝试将示例项目烧录至您的开发板。
-
-如需使用较早 GNU Make 编译系统,则请参考 :ref:`get-started-step-by-step` 章节。
+之后,请前往 :doc:`../get-started/index` 中的 :ref:`get-started-step-by-step` 章节,查看如何设置开发环境,并尝试将示例项目烧录至您的开发板。
 
 
 相关文档

+ 5 - 8
docs/zh_CN/hw-reference/get-started-devkitc.rst

@@ -9,14 +9,14 @@ ESP32-DevKitC V4 入门指南
 准备工作
 -----------
 
-* :ref:`ESP32-DevKitC V4 开发板 <get-started-esp32-devkitc-board-front-cmake>`
+* :ref:`ESP32-DevKitC V4 开发板 <get-started-esp32-devkitc-board-front>`
 * USB A / micro USB B 数据线
 * PC(Windows、Linux 或 Mac OS)
 
 您可以跳过介绍部分,直接前往 `应用程序开发`_ 章节。
 
 
-.. _DevKitC-Overview-cmake:
+.. _DevKitC-Overview:
 
 概述
 ----
@@ -46,7 +46,7 @@ ESP32-DevKitC V4 是 `乐鑫 <https://espressif.com>`_ 一款基于 ESP32 的小
 
 ESP32-DevKitC V4 开发板的主要组件、接口及控制方式见下。
 
-.. _get-started-esp32-devkitc-board-front-cmake:
+.. _get-started-esp32-devkitc-board-front:
 
 .. figure:: ../../_static/esp32-devkitc-functional-overview.jpg
 	:align: center
@@ -121,10 +121,7 @@ C15(黄色)在 ESP32-DevKitC V4 开发板上的位置
 
 ESP32-DevKitC V4 上电前,请首先确认开发板完好无损。
 
-之后,请前往 :doc:`../get-started-cmake/index` 中的 :ref:`get-started-step-by-step-cmake` 章节,查看如何设置开发环境,并尝试将示例项目烧录至您的开发板。
-
-如需使用较早 GNU Make 编译系统,则请参考 :ref:`get-started-step-by-step` 章节。
-
+之后,请前往 :doc:`../get-started/index` 中的 :ref:`get-started-step-by-step` 章节,查看如何设置开发环境,并尝试将示例项目烧录至您的开发板。
 
 开发板尺寸
 -------------
@@ -151,4 +148,4 @@ ESP32-DevKitC 开发板尺寸 -- 仰视图
 .. toctree::
 	:hidden:
 
-	get-started-devkitc-v2
+	get-started-devkitc-v2

+ 1 - 3
docs/zh_CN/hw-reference/get-started-pico-kit-v3.rst

@@ -65,9 +65,7 @@ EN                  复位按键。
 
 ESP32-PICO-KIT V3 上电前,请首先确认开发板完好无损。
 
-之后,请前往 :doc:`../get-started-cmake/index` 中的 :ref:`get-started-step-by-step-cmake` 章节,查看如何设置开发环境,并尝试将示例项目烧录至您的开发板。
-
-如需使用较早 GNU Make 编译系统,则请参考 :ref:`get-started-step-by-step` 章节。
+之后,请前往 :doc:`../get-started/index` 中的 :ref:`get-started-step-by-step` 章节,查看如何设置开发环境,并尝试将示例项目烧录至您的开发板。
 
 
 相关文档

+ 16 - 18
docs/zh_CN/hw-reference/get-started-pico-kit.rst

@@ -10,7 +10,7 @@ ESP32-PICO-KIT V4/V4.1 入门指南
 准备工作
 --------
 
-* :ref:`ESP32-PICO-KIT 迷你开发板 <get-started-pico-kit-v4-board-front-cmake>`
+* :ref:`ESP32-PICO-KIT 迷你开发板 <get-started-pico-kit-v4-board-front>`
 * USB 2.0 线(A 型转 Micro-B 型)
 * PC(Windows、Linux 或 Mac OS)
 
@@ -56,7 +56,7 @@ ESP32-PICO-KIT 开发板的主要组件和连接方式见下。
 
 ESP32-PICO-KIT 开发板的主要组件、接口及控制方式见下。
 
-.. _get-started-pico-kit-v4-board-front-cmake:
+.. _get-started-pico-kit-v4-board-front:
 
 .. figure:: ../../_static/esp32-pico-kit-v4.1-f-layout.jpeg
     :align: center
@@ -106,7 +106,7 @@ EN                  复位按键。
 管脚说明
 ----------
 
-下表介绍了开发板 I/O 管脚的 **名称** 和 **功能**,具体布局请见 `相关文档`_ 中的原理图。请参考 :ref:`get-started-pico-kit-v4-board-front-cmake`。
+下表介绍了开发板 I/O 管脚的 **名称** 和 **功能**,具体布局请见 `相关文档`_ 中的原理图。请参考 :ref:`get-started-pico-kit-v4-board-front`。
 
 
 Header J2
@@ -115,9 +115,9 @@ Header J2
 ======  =================  ======  ======================================================
 编号     名称               类型     功能
 ======  =================  ======  ======================================================
-1       FLASH_SD1 (FSD1)   I/O     | GPIO8, SD_DATA1, SPID, HS1_DATA1 :ref:`(见说明 1) <get-started-pico-kit-v4-pin-notes-cmake>` , U2CTS
-2       FLASH_SD3 (FSD3)   I/O     | GPIO7, SD_DATA0, SPIQ, HS1_DATA0 :ref:`(见说明 1) <get-started-pico-kit-v4-pin-notes-cmake>` , U2RTS
-3       FLASH_CLK (FCLK)   I/O     | GPIO6, SD_CLK, SPICLK, HS1_CLK :ref:`(见说明 1) <get-started-pico-kit-v4-pin-notes-cmake>` , U1CTS 
+1       FLASH_SD1 (FSD1)   I/O     | GPIO8, SD_DATA1, SPID, HS1_DATA1 :ref:`(见说明 1) <get-started-pico-kit-v4-pin-notes>` , U2CTS
+2       FLASH_SD3 (FSD3)   I/O     | GPIO7, SD_DATA0, SPIQ, HS1_DATA0 :ref:`(见说明 1) <get-started-pico-kit-v4-pin-notes>` , U2RTS
+3       FLASH_CLK (FCLK)   I/O     | GPIO6, SD_CLK, SPICLK, HS1_CLK :ref:`(见说明 1) <get-started-pico-kit-v4-pin-notes>` , U1CTS 
 4       IO21               I/O     | GPIO21, VSPIHD, EMAC_TX_EN
 5       IO22               I/O     | GPIO22, VSPIWP, U0RTS, EMAC_TXD1
 6       IO19               I/O     | GPIO19, VSPIQ, U0CTS, EMAC_TXD0
@@ -126,8 +126,8 @@ Header J2
 9       IO5                I/O     | GPIO5, VSPICS0, HS1_DATA6, EMAC_RX_CLK
 10      IO10               I/O     | GPIO10, SD_DATA3, SPIWP, HS1_DATA3, U1TXD
 11      IO9                I/O     | GPIO9, SD_DATA2, SPIHD, HS1_DATA2, U1RXD
-12      RXD0               I/O     | GPIO3, U0RXD :ref:`(见说明 3) <get-started-pico-kit-v4-pin-notes-cmake>` , CLK_OUT2
-13      TXD0               I/O     | GPIO1, U0TXD :ref:`(见说明 3) <get-started-pico-kit-v4-pin-notes-cmake>` , CLK_OUT3, EMAC_RXD2
+12      RXD0               I/O     | GPIO3, U0RXD :ref:`(见说明 3) <get-started-pico-kit-v4-pin-notes>` , CLK_OUT2
+13      TXD0               I/O     | GPIO1, U0TXD :ref:`(见说明 3) <get-started-pico-kit-v4-pin-notes>` , CLK_OUT3, EMAC_RXD2
 14      IO35               I       | ADC1_CH7, RTC_GPIO5
 15      IO34               I       | ADC1_CH6, RTC_GPIO4
 16      IO38               I       | GPIO38, ADC1_CH2, RTC_GPIO2
@@ -144,20 +144,20 @@ Header J3
 ======  =================  ======  ======================================================
 No.     Name               Type    Function
 ======  =================  ======  ======================================================
-1       FLASH_CS (FCS)     I/O     | GPIO16, HS1_DATA4 :ref:`(见说明 1) <get-started-pico-kit-v4-pin-notes-cmake>` , U2RXD, EMAC_CLK_OUT
-2       FLASH_SD0 (FSD0)   I/O     | GPIO17, HS1_DATA5 :ref:`(见说明 1) <get-started-pico-kit-v4-pin-notes-cmake>` , U2TXD, EMAC_CLK_OUT_180
-3       FLASH_SD2 (FSD2)   I/O     | GPIO11, SD_CMD, SPICS0, HS1_CMD :ref:`(见说明 1) <get-started-pico-kit-v4-pin-notes-cmake>` , U1RTS
+1       FLASH_CS (FCS)     I/O     | GPIO16, HS1_DATA4 :ref:`(见说明 1) <get-started-pico-kit-v4-pin-notes>` , U2RXD, EMAC_CLK_OUT
+2       FLASH_SD0 (FSD0)   I/O     | GPIO17, HS1_DATA5 :ref:`(见说明 1) <get-started-pico-kit-v4-pin-notes>` , U2TXD, EMAC_CLK_OUT_180
+3       FLASH_SD2 (FSD2)   I/O     | GPIO11, SD_CMD, SPICS0, HS1_CMD :ref:`(见说明 1) <get-started-pico-kit-v4-pin-notes>` , U1RTS
 4       SENSOR_VP (FSVP)   I       | GPIO36, ADC1_CH0, RTC_GPIO0
 5       SENSOR_VN (FSVN)   I       | GPIO39, ADC1_CH3, RTC_GPIO3
 6       IO25               I/O     | GPIO25, DAC_1, ADC2_CH8, RTC_GPIO6, EMAC_RXD0
 7       IO26               I/O     | GPIO26, DAC_2, ADC2_CH9, RTC_GPIO7, EMAC_RXD1
-8       IO32               I/O     | 32K_XP :ref:`(见说明 2a) <get-started-pico-kit-v4-pin-notes-cmake>` , ADC1_CH4, TOUCH9, RTC_GPIO9
-9       IO33               I/O     | 32K_XN :ref:`(见说明 2b) <get-started-pico-kit-v4-pin-notes-cmake>` , ADC1_CH5, TOUCH8, RTC_GPIO8
+8       IO32               I/O     | 32K_XP :ref:`(见说明 2a) <get-started-pico-kit-v4-pin-notes>` , ADC1_CH4, TOUCH9, RTC_GPIO9
+9       IO33               I/O     | 32K_XN :ref:`(见说明 2b) <get-started-pico-kit-v4-pin-notes>` , ADC1_CH5, TOUCH8, RTC_GPIO8
 10      IO27               I/O     | GPIO27, ADC2_CH7, TOUCH7, RTC_GPIO17
                                    | EMAC_RX_DV
 11      IO14               I/O     | ADC2_CH6, TOUCH6, RTC_GPIO16, MTMS, HSPICLK,
                                    | HS2_CLK, SD_CLK, EMAC_TXD2
-12      IO12               I/O     | ADC2_CH5, TOUCH5, RTC_GPIO15, MTDI :ref:`(见说明 4) <get-started-pico-kit-v4-pin-notes-cmake>` , HSPIQ,
+12      IO12               I/O     | ADC2_CH5, TOUCH5, RTC_GPIO15, MTDI :ref:`(见说明 4) <get-started-pico-kit-v4-pin-notes>` , HSPIQ,
                                    | HS2_DATA2, SD_DATA2, EMAC_TXD3
 13      IO13               I/O     | ADC2_CH4, TOUCH4, RTC_GPIO14, MTCK, HSPID,
                                    | HS2_DATA3, SD_DATA3, EMAC_RX_ER
@@ -175,7 +175,7 @@ No.     Name               Type    Function
 ======  =================  ======  ======================================================
 
 
-.. _get-started-pico-kit-v4-pin-notes-cmake:
+.. _get-started-pico-kit-v4-pin-notes:
 
 有关上表的说明:
 
@@ -190,9 +190,7 @@ No.     Name               Type    Function
 
 ESP32-PICO-KIT 上电前,请首先确认开发板完好无损。
 
-之后,请前往 :doc:`../get-started-cmake/index` 中的 :ref:`get-started-step-by-step-cmake` 章节,查看如何设置开发环境,并尝试将示例项目烧录至您的开发板。
-
-如需使用较早 GNU Make 编译系统,则请参考 :ref:`get-started-step-by-step` 章节。
+之后,请前往 :doc:`../get-started/index` 中的 :ref:`get-started-step-by-step` 章节,查看如何设置开发环境,并尝试将示例项目烧录至您的开发板。
 
 
 开发板尺寸

+ 7 - 9
docs/zh_CN/hw-reference/get-started-wrover-kit-v2.rst

@@ -52,7 +52,7 @@ ESP-WROVER-KIT 开发板的主要组件和连接方式如下图所示。
 
 ESP-WROVER-KIT 开发板的主要组件、接口及控制方式见下。
 
-.. _get-started-esp-wrover-kit-v2-board-front-cmake:
+.. _get-started-esp-wrover-kit-v2-board-front:
 
 .. figure:: ../../_static/esp-wrover-kit-v2-layout-front.png
     :align: center
@@ -61,7 +61,7 @@ ESP-WROVER-KIT 开发板的主要组件、接口及控制方式见下。
 
     ESP-WROVER-KIT 开发板布局 -- 俯视图
 
-.. _get-started-esp-wrover-kit-v2-board-back-cmake:
+.. _get-started-esp-wrover-kit-v2-board-back:
 
 .. figure:: ../../_static/esp-wrover-kit-v2-layout-back.png
     :align: center
@@ -113,11 +113,11 @@ I/O                    板上模组的所有管脚均已引出至开发板的排
 
 MicroSD 卡槽            MicroSD 卡槽,可扩充存储空间:当 ESP32 进入下载模式时,GPIO2 不可处于高电平。然而,为了使能 MicroSD 卡功能,需为 GPIO2 增加一个上拉电阻。默认情况下,GPIO2 和上拉电阻 R153 处于断开状态。为了使能 MicroSD 卡,请按照 `设置选项`_ 章节的要求,连接 JP1 连接器。
 
-LCD 显示屏              支持贴装一款 3.2” 的 SPI(标准四线串行外设接口)LCD 显示器,请见 :ref:`get-started-esp-wrover-kit-v2-board-back-cmake`。
+LCD 显示屏              支持贴装一款 3.2” 的 SPI(标准四线串行外设接口)LCD 显示器,请见 :ref:`get-started-esp-wrover-kit-v2-board-back`。
 ====================  ======================================================================================================================================================================================================================================================================================================================================
 
 
-.. _get-started-esp-wrover-kit-v2-setup-options-cmake:
+.. _get-started-esp-wrover-kit-v2-setup-options:
 
 设置选项
 -------------
@@ -137,7 +137,7 @@ JP14     |jp14|            使能 RTS/CTS 串口流控
 =======  ================  =====================================================================================
 
 
-.. _get-started-esp-wrover-kit-v2-start-development-cmake:
+.. _get-started-esp-wrover-kit-v2-start-development:
 
 应用程序开发
 -----------------------------
@@ -167,9 +167,7 @@ USB 供电                   使能 UART 通信
 正式开始开发
 ^^^^^^^^^^^^^^^^^^
 
-请前往 :doc:`../get-started-cmake/index` 中的 :ref:`get-started-step-by-step-cmake` 章节,查看如何设置开发环境,并尝试将示例项目烧录至您的开发板。
-
-如需使用较早 GNU Make 编译系统,则请参考 :ref:`get-started-step-by-step` 章节。
+请前往 :doc:`../get-started/index` 中的 :ref:`get-started-step-by-step` 章节,查看如何设置开发环境,并尝试将示例项目烧录至您的开发板。
 
 
 相关文档
@@ -191,4 +189,4 @@ USB 供电                   使能 UART 通信
 .. |jp11-tx-rx| image:: ../../_static/wrover-jp11-tx-rx.png
 .. |jp14| image:: ../../_static/wrover-jp14.png
 
-.. _ESP-WROVER-KIT V2 原理图: https://dl.espressif.com/dl/schematics/ESP-WROVER-KIT_SCH-2.pdf
+.. _ESP-WROVER-KIT V2 原理图: https://dl.espressif.com/dl/schematics/ESP-WROVER-KIT_SCH-2.pdf

+ 20 - 22
docs/zh_CN/hw-reference/get-started-wrover-kit-v3.rst

@@ -8,7 +8,7 @@ ESP-WROVER-KIT V3 入门指南
 准备工作
 -------------
 
-* :ref:`ESP-WROVER-KIT V3 开发板 <get-started-esp-wrover-kit-v3-board-front-cmake>`
+* :ref:`ESP-WROVER-KIT V3 开发板 <get-started-esp-wrover-kit-v3-board-front>`
 * USB 数据线(A 转 Micro-B)
 * PC(Windows、Linux 或 macOS)
 
@@ -52,7 +52,7 @@ ESP-WROVER-KIT 开发板的主要组件和连接方式如下图所示。
 
 ESP-WROVER-KIT 开发板的主要组件、接口及控制方式见下。
 
-.. _get-started-esp-wrover-kit-v3-board-front-cmake:
+.. _get-started-esp-wrover-kit-v3-board-front:
 
 .. figure:: ../../_static/esp-wrover-kit-v3-layout-front.jpg
     :align: center
@@ -61,7 +61,7 @@ ESP-WROVER-KIT 开发板的主要组件、接口及控制方式见下。
 
     ESP-WROVER-KIT 开发板布局 -- 俯视图
 
-.. _get-started-esp-wrover-kit-v3-board-back-cmake:
+.. _get-started-esp-wrover-kit-v3-board-back:
 
 .. figure:: ../../_static/esp-wrover-kit-v3-layout-back.jpg
     :align: center
@@ -115,11 +115,11 @@ I/O                     板上模组的所有管脚均已引出至开发板的
 
 MicroSD 卡槽            适用于需要扩充数据存储空间或进行备份的应用开发场景。
 
-LCD 显示屏               支持贴装一款 3.2” 的 SPI(标准四线串行外设接口)LCD 显示器,请见 :ref:`get-started-esp-wrover-kit-v3-board-back-cmake`。
+LCD 显示屏               支持贴装一款 3.2” 的 SPI(标准四线串行外设接口)LCD 显示器,请见 :ref:`get-started-esp-wrover-kit-v3-board-back`。
 ====================  ======================================================================================================================================================================================================================================================================================================================================
 
 
-.. _get-started-esp-wrover-kit-v3-setup-options-cmake:
+.. _get-started-esp-wrover-kit-v3-setup-options:
 
 设置选项
 -------------
@@ -175,17 +175,17 @@ JTAG,MicroSD          IO15   5V
 
 说明:
 
-* NC/XTAL - :ref:`32.768 kHz Oscillator <get-started-esp-wrover-kit-v3-xtal-cmake>`
-* JTAG - :ref:`JTAG / JP8 <get-started-esp-wrover-kit-v3-jtag-header-cmake>`
+* NC/XTAL - :ref:`32.768 kHz Oscillator <get-started-esp-wrover-kit-v3-xtal>`
+* JTAG - :ref:`JTAG / JP8 <get-started-esp-wrover-kit-v3-jtag-header>`
 * Boot - Boot 按键 / SW2
-* 摄像头 - :ref:`摄像头 / JP4 <get-started-esp-wrover-kit-v3-camera-header-cmake>`
-* LED - :ref:`RGB LED <get-started-esp-wrover-kit-v3-rgb-led-connections-cmake>`
-* MicroSD - :ref:`MicroSD Card / J4 <get-started-esp-wrover-kit-v3-microsd-card-slot-cmake>`
-* LCD - :ref:`LCD / U5 <get-started-esp-wrover-kit-v3-lcd-connector-cmake>`
+* 摄像头 - :ref:`摄像头 / JP4 <get-started-esp-wrover-kit-v3-camera-header>`
+* LED - :ref:`RGB LED <get-started-esp-wrover-kit-v3-rgb-led-connections>`
+* MicroSD - :ref:`MicroSD Card / J4 <get-started-esp-wrover-kit-v3-microsd-card-slot>`
+* LCD - :ref:`LCD / U5 <get-started-esp-wrover-kit-v3-lcd-connector>`
 * PSRAM - 仅适用于选贴 ESP32-WROVER 的情况。
 
 
-.. _get-started-esp-wrover-kit-v3-xtal-cmake:
+.. _get-started-esp-wrover-kit-v3-xtal:
 
 32.768 kHz 晶振
 ^^^^^^^^^^^^^^^^^^^^^
@@ -202,7 +202,7 @@ JTAG,MicroSD          IO15   5V
     默认情况下,管脚 GPIO32 和 GPIO33 已连接至晶振。因此,为了保证信号的完整性,这两个管脚并未连接至 JP1 I/O 连接器。用户可通过将 R11/R23 处的 0 欧电阻移至 R12/R24 处,以将 GP1O32 和 GPIO33 的连接从晶振移至 JP1。
 
 
-.. _get-started-esp-wrover-kit-v3-spi-flash-header-cmake:
+.. _get-started-esp-wrover-kit-v3-spi-flash-header:
 
 SPI Flash / JP13
 ^^^^^^^^^^^^^^^^
@@ -224,7 +224,7 @@ SPI Flash / JP13
 
 
 
-.. _get-started-esp-wrover-kit-v3-jtag-header-cmake:
+.. _get-started-esp-wrover-kit-v3-jtag-header:
 
 JTAG / JP8
 ^^^^^^^^^^
@@ -240,7 +240,7 @@ JTAG / JP8
 ====  ==============  =============
 
 
-.. _get-started-esp-wrover-kit-v3-camera-header-cmake:
+.. _get-started-esp-wrover-kit-v3-camera-header:
 
 摄像头 / JP4
 ^^^^^^^^^^^^
@@ -271,7 +271,7 @@ JTAG / JP8
 * D0 到 D7 为摄像头的数据总线
 
 
-.. _get-started-esp-wrover-kit-v3-rgb-led-connections-cmake:
+.. _get-started-esp-wrover-kit-v3-rgb-led-connections:
 
 RGB LED
 ^^^^^^^
@@ -285,7 +285,7 @@ RGB LED
 ====  ==========  =========
 
 
-.. _get-started-esp-wrover-kit-v3-microsd-card-slot-cmake:
+.. _get-started-esp-wrover-kit-v3-microsd-card-slot:
 
 MicroSD 卡
 ^^^^^^^^^^^^
@@ -303,7 +303,7 @@ MicroSD 卡
 ====  ==============  ===============
 
 
-.. _get-started-esp-wrover-kit-v3-lcd-connector-cmake:
+.. _get-started-esp-wrover-kit-v3-lcd-connector:
 
 LCD / U5
 ^^^^^^^^
@@ -321,7 +321,7 @@ LCD / U5
 ====  ==============  ===============
 
 
-.. _get-started-esp-wrover-kit-v3-start-development-cmake:
+.. _get-started-esp-wrover-kit-v3-start-development:
 
 应用程序开发
 -----------------------------
@@ -351,9 +351,7 @@ USB 供电                   使能 UART 通信
 正式开始开发
 ^^^^^^^^^^^^^^^^^^
 
-请前往 :doc:`../get-started-cmake/index` 中的 :ref:`get-started-step-by-step-cmake` 章节,查看如何设置开发环境,并尝试将示例项目烧录至您的开发板。
-
-如需使用较早 GNU Make 编译系统,则请参考 :ref:`get-started-step-by-step` 章节。
+请前往 :doc:`../get-started/index` 中的 :ref:`get-started-step-by-step` 章节,查看如何设置开发环境,并尝试将示例项目烧录至您的开发板。
 
 
 相关文档

+ 21 - 21
docs/zh_CN/hw-reference/get-started-wrover-kit.rst

@@ -8,7 +8,7 @@ ESP-WROVER-KIT V4.1 入门指南
 准备工作
 -------------
 
-* :ref:`ESP-WROVER-KIT V4.1 开发板 <get-started-esp-wrover-kit-v4.1-board-front-cmake>`
+* :ref:`ESP-WROVER-KIT V4.1 开发板 <get-started-esp-wrover-kit-v4.1-board-front>`
 * USB 数据线(A 转 Micro-B)
 * PC(Windows、Linux 或 macOS)
 
@@ -53,7 +53,7 @@ ESP-WROVER-KIT 开发板的主要组件和连接方式如下图所示。
 
 ESP-WROVER-KIT 开发板的主要组件、接口及控制方式见下。
 
-.. _get-started-esp-wrover-kit-v4.1-board-front-cmake:
+.. _get-started-esp-wrover-kit-v4.1-board-front:
 
 .. figure:: ../../_static/esp-wrover-kit-v4.1-layout-front.png
     :align: center
@@ -62,7 +62,7 @@ ESP-WROVER-KIT 开发板的主要组件、接口及控制方式见下。
 
     ESP-WROVER-KIT 开发板布局 -- 俯视图
 
-.. _get-started-esp-wrover-kit-v4.1-board-back-cmake:
+.. _get-started-esp-wrover-kit-v4.1-board-back:
 
 .. figure:: ../../_static/esp-wrover-kit-v4.1-layout-back.png
     :align: center
@@ -120,11 +120,11 @@ I/O 连接器               板上模组的所有管脚均已引出至开发板
 
 MicroSD 卡槽            适用于需要扩充数据存储空间或进行备份的应用开发场景。
 
-LCD 显示屏               支持贴装一款 3.2” 的 SPI(标准四线串行外设接口)LCD 显示器,请见 :ref:`get-started-esp-wrover-kit-v4.1-board-back-cmake`。
+LCD 显示屏               支持贴装一款 3.2” 的 SPI(标准四线串行外设接口)LCD 显示器,请见 :ref:`get-started-esp-wrover-kit-v4.1-board-back`。
 ====================  ======================================================================================================================================================================================================================================================================================================================================
 
 
-.. _get-started-esp-wrover-kit-v4.1-setup-options-cmake:
+.. _get-started-esp-wrover-kit-v4.1-setup-options:
 
 设置选项
 -------------
@@ -180,17 +180,17 @@ JTAG,MicroSD          IO15   5V
 
 说明:
 
-* NC/XTAL - :ref:`32.768 kHz 晶振 <get-started-esp-wrover-kit-v4.1-xtal-cmake>`
-* JTAG - :ref:`JTAG / JP8 <get-started-esp-wrover-kit-v4.1-jtag-header-cmake>`
+* NC/XTAL - :ref:`32.768 kHz 晶振 <get-started-esp-wrover-kit-v4.1-xtal>`
+* JTAG - :ref:`JTAG / JP8 <get-started-esp-wrover-kit-v4.1-jtag-header>`
 * Boot - Boot 按键 / SW2
-* 摄像头 - :ref:`摄像头 / JP4 <get-started-esp-wrover-kit-v4.1-camera-header-cmake>`
-* LED - :ref:`RGB LED <get-started-esp-wrover-kit-v4.1-rgb-led-connections-cmake>`
-* MicroSD - :ref:`MicroSD Card / J4 <get-started-esp-wrover-kit-v4.1-microsd-card-slot-cmake>`
-* LCD - :ref:`LCD / U5 <get-started-esp-wrover-kit-v4.1-lcd-connector-cmake>`
+* 摄像头 - :ref:`摄像头 / JP4 <get-started-esp-wrover-kit-v4.1-camera-header>`
+* LED - :ref:`RGB LED <get-started-esp-wrover-kit-v4.1-rgb-led-connections>`
+* MicroSD - :ref:`MicroSD Card / J4 <get-started-esp-wrover-kit-v4.1-microsd-card-slot>`
+* LCD - :ref:`LCD / U5 <get-started-esp-wrover-kit-v4.1-lcd-connector>`
 * PSRAM - ESP32-WROVER-B 的 PSRAM
 
 
-.. _get-started-esp-wrover-kit-v4.1-xtal-cmake:
+.. _get-started-esp-wrover-kit-v4.1-xtal:
 
 32.768 kHz 晶振
 ^^^^^^^^^^^^^^^^^^^^^
@@ -207,7 +207,7 @@ JTAG,MicroSD          IO15   5V
     默认情况下,管脚 GPIO32 和 GPIO33 已连接至晶振。因此,为了保证信号的完整性,这两个管脚并未连接至 JP1 I/O 连接器。用户可通过将 R11/R23 处的 0 欧电阻移至 R12/R24 处,以将 GP1O32 和 GPIO33 的连接从晶振移至 JP1。
 
 
-.. _get-started-esp-wrover-kit-v4.1-spi-flash-header-cmake:
+.. _get-started-esp-wrover-kit-v4.1-spi-flash-header:
 
 SPI Flash / JP2
 ^^^^^^^^^^^^^^^
@@ -229,7 +229,7 @@ SPI Flash / JP2
 
 
 
-.. _get-started-esp-wrover-kit-v4.1-jtag-header-cmake:
+.. _get-started-esp-wrover-kit-v4.1-jtag-header:
 
 JTAG / JP2
 ^^^^^^^^^^
@@ -245,7 +245,7 @@ JTAG / JP2
 ====  ==============  =============
 
 
-.. _get-started-esp-wrover-kit-v4.1-camera-header-cmake:
+.. _get-started-esp-wrover-kit-v4.1-camera-header:
 
 摄像头 / JP4
 ^^^^^^^^^^^^
@@ -276,7 +276,7 @@ JTAG / JP2
 * D0 到 D7 为摄像头的数据总线
 
 
-.. _get-started-esp-wrover-kit-v4.1-rgb-led-connections-cmake:
+.. _get-started-esp-wrover-kit-v4.1-rgb-led-connections:
 
 RGB LED
 ^^^^^^^
@@ -290,7 +290,7 @@ RGB LED
 ====  ==========  =========
 
 
-.. _get-started-esp-wrover-kit-v4.1-microsd-card-slot-cmake:
+.. _get-started-esp-wrover-kit-v4.1-microsd-card-slot:
 
 MicroSD 卡
 ^^^^^^^^^^^^
@@ -308,7 +308,7 @@ MicroSD 卡
 ====  ==============  ===============
 
 
-.. _get-started-esp-wrover-kit-v4.1-lcd-connector-cmake:
+.. _get-started-esp-wrover-kit-v4.1-lcd-connector:
 
 LCD / U5
 ^^^^^^^^
@@ -326,7 +326,7 @@ LCD / U5
 ====  ==============  ===============
 
 
-.. _get-started-esp-wrover-kit-start-development-cmake:
+.. _get-started-esp-wrover-kit-start-development:
 
 应用程序开发
 -----------------------------
@@ -356,7 +356,7 @@ USB 供电                   使能 UART 通信
 正式开始开发
 ^^^^^^^^^^^^^^^^^^
 
-请前往 :doc:`../get-started-cmake/index` 中的 :ref:`get-started-step-by-step-cmake` 章节,查看如何设置开发环境,并尝试将示例项目烧录至您的开发板。
+请前往 :doc:`../get-started/index` 中的 :ref:`get-started-step-by-step` 章节,查看如何设置开发环境,并尝试将示例项目烧录至您的开发板。
 
 如需使用较早 GNU Make 编译系统,则请参考 :ref:`get-started-step-by-step` 章节。
 
@@ -382,4 +382,4 @@ USB 供电                   使能 UART 通信
     :hidden:
 
     get-started-wrover-kit-v3.rst
-    get-started-wrover-kit-v2.rst
+    get-started-wrover-kit-v2.rst