Skip to content

Commit 14ed14d

Browse files
committed
doc: Fix links to point to v3.3.1 ESP-IDF documenation
1 parent 077ef1d commit 14ed14d

File tree

2 files changed

+6
-6
lines changed

2 files changed

+6
-6
lines changed

docs/docs_common.mk

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ clean:
6262
# Note: This is intended to help developers who generate the documentation on their local machine. Read The Docs uses
6363
# the requirements.txt file directly and calls sphinx also directly without the use of the makefile!
6464
check_python_packages:
65-
$(IDF_PATH)/tools/check_python_dependencies.py -r $(IDF_PATH)/docs/requirements.txt
65+
$(IDF_PATH)/tools/check_python_dependencies.py -r $(ADF_PATH)/docs/requirements.txt
6666

6767
html: | check_python_packages
6868
$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html

docs/en/get-started/index.rst

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -42,16 +42,16 @@ To use ESP-ADF you need set up the ESP-IDF first, and this is described in the n
4242

4343
.. note::
4444

45-
ESP-ADF is developed using `stable version of ESP-IDF <https://docs.espressif.com/projects/esp-idf/en/stable/versions.html>`_. If your have already set up another version, please switch to the stable, or you may not be able to compile ESP-ADF applications.
45+
ESP-ADF is developed using `v3.3.1 version of ESP-IDF <https://docs.espressif.com/projects/esp-idf/en/v3.3.1/versions.html>`_. If your have already set up another version, please switch to the v3.3.1, or you may not be able to compile ESP-ADF applications.
4646

4747
.. _get-started-setup-esp-idf:
4848

4949
Set up ESP-IDF
5050
==============
5151

52-
Configure your PC according to `ESP32 Documentation <https://docs.espressif.com/projects/esp-idf/en/stable/>`_. `Windows <https://docs.espressif.com/projects/esp-idf/en/stable/get-started/windows-setup.html>`_, `Linux <https://docs.espressif.com/projects/esp-idf/en/stable/get-started/linux-setup.html>`_ and `Mac OS <https://docs.espressif.com/projects/esp-idf/en/stable/get-started/macos-setup.html>`_ operating systems are supported.
52+
Configure your PC according to `ESP32 Documentation <https://docs.espressif.com/projects/esp-idf/en/v3.3.1/>`_. `Windows <https://docs.espressif.com/projects/esp-idf/en/v3.3.1/get-started/windows-setup.html>`_, `Linux <https://docs.espressif.com/projects/esp-idf/en/v3.3.1/get-started/linux-setup.html>`_ and `Mac OS <https://docs.espressif.com/projects/esp-idf/en/v3.3.1/get-started/macos-setup.html>`_ operating systems are supported.
5353

54-
You have a choice to compile and upload code to the ESP32 by command line with `make <https://docs.espressif.com/projects/esp-idf/en/stable/get-started/make-project.html>`_ or using `Eclipse IDE <https://docs.espressif.com/projects/esp-idf/en/stable/get-started/eclipse-setup.html>`_.
54+
You have a choice to compile and upload code to the ESP32 by command line with `make <https://docs.espressif.com/projects/esp-idf/en/v3.3.1/get-started/make-project.html>`_ or using `Eclipse IDE <https://docs.espressif.com/projects/esp-idf/en/v3.3.1/get-started/eclipse-setup.html>`_.
5555

5656
.. note::
5757

@@ -89,7 +89,7 @@ ESP-ADF will be downloaded into ``~/esp/esp-adf``.
8989
Setup Path to ESP-ADF
9090
=====================
9191

92-
The toolchain programs access ESP-ADF using ``ADF_PATH`` environment variable. This variable should be set up on your PC, otherwise the projects will not build. The process to set it up is analogous to setting up the ``IDF_PATH`` variable, please see instructions in ESP-IDF documentation under `Add IDF_PATH to User Profile <https://docs.espressif.com/projects/esp-idf/en/stable/get-started/add-idf_path-to-profile.html>`_.
92+
The toolchain programs access ESP-ADF using ``ADF_PATH`` environment variable. This variable should be set up on your PC, otherwise the projects will not build. The process to set it up is analogous to setting up the ``IDF_PATH`` variable, please see instructions in ESP-IDF documentation under `Add IDF_PATH to User Profile <https://docs.espressif.com/projects/esp-idf/en/v3.3.1/get-started/add-idf_path-to-profile.html>`_.
9393

9494

9595
.. _get-started-start-project:
@@ -119,7 +119,7 @@ You can also find a range of example projects under the :adf:`examples` director
119119
Connect and Configure
120120
=====================
121121

122-
Connect the audio ESP32 board to the PC, check under what serial port the board is visible and verify, if serial communication works as described in `ESP-IDF Documentation <https://docs.espressif.com/projects/esp-idf/en/stable/get-started/establish-serial-connection.html>`_.
122+
Connect the audio ESP32 board to the PC, check under what serial port the board is visible and verify, if serial communication works as described in `ESP-IDF Documentation <https://docs.espressif.com/projects/esp-idf/en/v3.3.1/get-started/establish-serial-connection.html>`_.
123123

124124
At the terminal window, go to the directory of ``play_mp3`` application and configure it with ``menuconfig`` by selecting the serial port, upload speed and the audio board version::
125125

0 commit comments

Comments
 (0)