alex/esp-idf
1
0
Fork 0
mirror of https://github.com/espressif/esp-idf.git synced 2025-10-28 04:05:39 +00:00
Code Issues Packages Projects Releases Wiki Activity

Docs: build doc with new layout for target and version select

Browse Source
This commit is contained in:
Marius Vikhammer
2020-07-30 11:47:24 +08:00
committed by bot
parent eeab4e4469
commit 539f7edbb3
7 changed files with 74 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/en/index.rst
View File

@@ -6,7 +6,7 @@ This is the documentation for Espressif IoT Development Framework (`esp-idf <htt
.. 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.
This document describes using ESP-IDF with the {IDF_TARGET_NAME} SoC. To switch to a different SoC target, choose target from the dropdown in the upper left.
.. only:: latex

4
docs/en/languages.rst
View File

@@ -8,9 +8,9 @@ The ESP-IDF Programming Manual is now available in two languages. Please refer t
- English/英文
- Chinese/中文
You can easily change from one language to another by the panel on the sidebar like below. Just click on the **Read the Docs** title button on the left-bottom corner if it is folded.
You can easily change from one language to another by clicking the language link you can find at the top of every document that has a translation.
如下图所示，你可使用边栏的面板进行语言的切换。如果该面板被折叠，点击左下角 **Read the Docs** 标题按钮来显示它。
.. image:: /../_static/choose_version.png
.. image:: /../_static/choose_language.png

12
docs/en/versions.rst
View File

@@ -21,9 +21,17 @@ https://docs.espressif.com/projects/esp-idf/en/latest/
The full history of releases can be found on the GitHub repository `Releases page`_. There you can find release notes, links to each version of the documentation, and instructions for obtaining each version.
Another place to find documentation for all releases is the documentation page, where you can go to the bottom-left corner and click the versions dropup (a bar with a small triangle). You can also use this dropup to switch between versions of the documentation.
.. only:: html
Another place to find documentation for all current releases is the documentation page, where you can go to the upper-left corner and click the version dropdown (between the target dropdown and the search bar). You can also use this dropdown to switch between versions of the documentation.
.. image:: /../_static/choose_version.png
Documentation for older versions are also still available:
.. raw:: html
:file: ../_static/version_table.html
.. image:: /../_static/choose_version.png
Which Version Should I Start With?