From: Krzysztof Date: Fri, 2 Aug 2019 09:09:33 +0000 (+0800) Subject: Fix broken links in 'Getting Started' gudes X-Git-Tag: v4.1-dev~26^2~1 X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=d163b9e6150ce8409aaba9cb80ba4e58419de178;p=esp-idf Fix broken links in 'Getting Started' gudes --- diff --git a/docs/en/get-started/linux-setup-scratch.rst b/docs/en/get-started/linux-setup-scratch.rst index a96992c062..56e590c54a 100644 --- a/docs/en/get-started/linux-setup-scratch.rst +++ b/docs/en/get-started/linux-setup-scratch.rst @@ -66,7 +66,7 @@ Build the toolchain:: ./ct-ng build chmod -R u+w builds/xtensa-esp32-elf -Toolchain will be built in ``~/esp/crosstool-NG/builds/xtensa-esp32-elf``. Follow `instructions for standard setup `_ to add the toolchain to your ``PATH``. +Toolchain will be built in ``~/esp/crosstool-NG/builds/xtensa-esp32-elf``. Follow :ref:`instructions for standard setup ` to add the toolchain to your ``PATH``. Next Steps diff --git a/docs/en/get-started/windows-setup-scratch.rst b/docs/en/get-started/windows-setup-scratch.rst index d0bef754df..3e35f916ea 100644 --- a/docs/en/get-started/windows-setup-scratch.rst +++ b/docs/en/get-started/windows-setup-scratch.rst @@ -56,9 +56,9 @@ Ninja build .. note:: Ninja currently only provides binaries for 64-bit Windows. It is possible to use CMake and ``idf.py`` with other build tools, such as mingw-make, on 32-bit windows. However this is currently undocumented. -Download the ninja_ latest stable Windows release from the (`download page `_). +Download the ninja_ latest stable Windows release from the (`download page `_). -The Ninja for Windows download is a .zip file containing a single ``ninja.exe`` file which needs to be unzipped to a directory which is then `added to your Path `_ (or you can choose a directory which is already on your Path). +The Ninja for Windows download is a .zip file containing a single ``ninja.exe`` file which needs to be unzipped to a directory which is then :ref:`added to your Path ` (or you can choose a directory which is already on your Path). Python 2.x @@ -77,7 +77,7 @@ MConf for IDF Download the configuration tool mconf-idf from the `kconfig-frontends releases page `_. This is the ``mconf`` configuration tool with some minor customizations for ESP-IDF. -This tool will also need to be unzipped to a directory which is then `added to your Path `_. +This tool will also need to be unzipped to a directory which is then :ref:`added to your Path `. Toolchain Setup =============== @@ -90,7 +90,7 @@ Download the precompiled Windows toolchain: Unzip the zip file to ``C:\Program Files`` (or some other location). The zip file contains a single directory ``xtensa-esp32-elf``. -Next, the ``bin`` subdirectory of this directory must be `added to your Path `_. For example, the directory to add may be ``C:\Program Files\xtensa-esp32-elf\bin``. +Next, the ``bin`` subdirectory of this directory must be :ref:`added to your Path `. For example, the directory to add may be ``C:\Program Files\xtensa-esp32-elf\bin``. .. note:: If you already have the MSYS2 environment (for use with the "GNU Make" build system) installed, you can skip the separate download and add the directory ``C:\msys32\opt\xtensa-esp32-elf\bin`` to the Path instead, as the toolchain is included in the MSYS2 environment. @@ -114,6 +114,7 @@ Next Steps To carry on with development environment setup, proceed to :ref:`get-started-get-esp-idf`. .. _ninja: https://ninja-build.org/ +.. _ninja-dl: https://github.com/ninja-build/ninja/releases .. _Python: https://www.python.org/downloads/windows/ .. _MSYS2: https://msys2.github.io/ .. _Stable version: https://docs.espressif.com/projects/esp-idf/en/stable/