docs: Add a note about what target this doc version is for

This commit is contained in:
Angus Gratton 2020-03-06 11:33:43 +11:00 committed by Angus Gratton
parent 296a1db3c6
commit e0eb218e7a

View File

@ -2,7 +2,16 @@ ESP-IDF Programming Guide
=========================
:link_to_translation:`zh_CN:[中文]`
This is the documentation for Espressif IoT Development Framework (`esp-idf <https://github.com/espressif/esp-idf>`_). ESP-IDF is the official development framework for the `ESP32 <https://espressif.com/en/products/hardware/esp32/overview>`_ chip.
This is the documentation for Espressif IoT Development Framework (`esp-idf <https://github.com/espressif/esp-idf>`_). ESP-IDF is the official development framework for the `ESP32 <https://www.espressif.com/en/products/hardware/socs>`_ SoC family.
.. only:: html
This document describes using ESP-IDF with the {IDF_TARGET_NAME} SoC. To switch to a different SoC target, click "Switch Version" in the bottom left.
.. only:: latex
This document describes using ESP-IDF with the {IDF_TARGET_NAME} SoC.
================== ================== ==================
|Get Started|_ |API Reference|_ |H/W Reference|_