From e0eb218e7a74071f0871c949909078e9d5015865 Mon Sep 17 00:00:00 2001 From: Angus Gratton Date: Fri, 6 Mar 2020 11:33:43 +1100 Subject: [PATCH] docs: Add a note about what target this doc version is for --- docs/en/index.rst | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) diff --git a/docs/en/index.rst b/docs/en/index.rst index f9cf88b1db..90abc39b70 100644 --- a/docs/en/index.rst +++ b/docs/en/index.rst @@ -2,7 +2,16 @@ ESP-IDF Programming Guide ========================= :link_to_translation:`zh_CN:[中文]` -This is the documentation for Espressif IoT Development Framework (`esp-idf `_). ESP-IDF is the official development framework for the `ESP32 `_ chip. +This is the documentation for Espressif IoT Development Framework (`esp-idf `_). ESP-IDF is the official development framework for the `ESP32 `_ 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|_