Skip to content

Commit 4586e4b

Browse files
peterdragunradimkarnis
authored andcommitted
docs: Clarify versions in documentation
1 parent cbd4e9b commit 4586e4b

File tree

2 files changed

+11
-1
lines changed

2 files changed

+11
-1
lines changed

docs/conf_common.py

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -59,3 +59,7 @@
5959
project_slug = "esptool"
6060

6161
versions_url = "./_static/esptool_versions.js"
62+
63+
64+
def conf_setup(app, config):
65+
config.html_baseurl = f"https://docs.espressif.com/projects/esptool/{config.language}/stable/{config.idf_target}/"

docs/en/index.rst

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,13 @@
11
Esptool Documentation
22
=====================
33

4+
.. important::
5+
6+
This document describes how to use ``esptool`` with the {IDF_TARGET_NAME} SoC. To switch to a different SoC target, choose target from the dropdown in the upper left corner.
7+
8+
Please note that this documentation is for the version of ``esptool`` v5. You can find your version in the command output or by running ``esptool version``.
9+
For the version of ``esptool`` v4 please refer to the `v4 documentation <https://docs.espressif.com/projects/esptool/en/release-v4/esp32/>`_ or pick from the dropdown in the upper left corner.
10+
411
This is the documentation for ``esptool`` - a Python-based, open-source, platform-independent utility for flashing, provisioning, and interacting with Espressif SoCs. Esptool communicates with the ROM bootloader (or the flasher stub) in `Espressif SoCs <https://www.espressif.com/en/products/hardware/socs>`_.
512

613
The flasher stub is a small program included with esptool that replaces the original ROM bootloader in the chip to fix some of its limitations and bugs. See :ref:`stub` for more details.
@@ -15,7 +22,6 @@ The flasher stub is a small program included with esptool that replaces the orig
1522

1623
``esptool`` can be used both as a command-line tool and as a Python library. The command-line is the most common way to use the tool, and is the primary focus of this documentation. To use it as a library, see the :ref:`scripting <scripting>` section.
1724

18-
This document describes using ``esptool`` with the {IDF_TARGET_NAME} SoC. To switch to a different SoC target, choose target from the dropdown in the upper left.
1925

2026
Quick Start
2127
-----------

0 commit comments

Comments
 (0)