esp-idf/docs/en/index.rst

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 and ESP32-S Series SoCs <https://www.espressif.com/en/products/hardware/socs>`_.

.. 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|_
------------------  ------------------  ------------------
`Get Started`_      `API Reference`_    `H/W Reference`_
------------------  ------------------  ------------------
|API Guides|_       |Contribute|_       |Resources|_
------------------  ------------------  ------------------
`API Guides`_       `Contribute`_       `Resources`_
==================  ==================  ==================

.. |Get Started| image:: ../_static/get-started.png
.. _Get Started: get-started/index.html

.. |API Reference| image:: ../_static/api-reference.png
.. _API Reference: api-reference/index.html

.. |H/W Reference| image:: ../_static/hw-reference.png
.. _H/W Reference: hw-reference/index.html

.. |API Guides| image:: ../_static/api-guides.png
.. _API Guides: api-guides/index.html

.. _Libraries and Frameworks: libraries-and-frameworks/index.html

.. |Contribute| image:: ../_static/contribute.png
.. _Contribute: contribute/index.html

.. |Resources| image:: ../_static/resources.png
.. _Resources: resources.html


.. toctree::
   :hidden:

   :esp32s2: ESP32-S2 Preview Support <esp32s2>
   Get Started <get-started/index>
   API Reference <api-reference/index>
   H/W Reference <hw-reference/index>
   API Guides <api-guides/index>
   Libraries and Frameworks <libraries-and-frameworks/index>
   Contribute <contribute/index>
   Versions <versions>
   Resources <resources>
   Copyrights <COPYRIGHT>
   About <about>
   语言/Languages <languages>
   Guide Downloads <https://readthedocs.com/projects/espressif-esp-idf/downloads/>
   
* :ref:`genindex`
docs: update index, improve structure of the readme 2017-01-15 17:48:47 +00:00			`ESP-IDF Programming Guide`
			`=========================`
docs: add language link to easily change to Chinese version 2018-03-14 09:03:56 +00:00			:link_to_translation:`zh_CN:[中文]`
Initial Sphinx / ReadTheDocs.org configuration 2016-10-23 20:14:24 +00:00
doc: Rephrase the support for ESP32 & ESP32-S on the home page 2020-03-24 03:58:55 +00:00			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 and ESP32-S Series SoCs <https://www.espressif.com/en/products/hardware/socs>`_.
docs: Add a note about what target this doc version is for 2020-03-06 00:33:43 +00:00
			`.. 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.`

doc: Index clean up 2016-11-16 19:17:44 +00:00
Restored back original 'zh_CN' version files and updated links between versions 2018-02-03 21:12:13 +00:00			`================== ================== ==================`
			`\|Get Started\|_ \|API Reference\|_ \|H/W Reference\|_`
			`------------------ ------------------ ------------------`
			`Get Started`_ `API Reference`_ `H/W Reference`_
			`------------------ ------------------ ------------------`
			`\|API Guides\|_ \|Contribute\|_ \|Resources\|_`
			`------------------ ------------------ ------------------`
			`API Guides`_ `Contribute`_ `Resources`_
			`================== ================== ==================`

Replace gif images on EN and zh_CN index pages with identical png images for successful building of PDFs on ReadTheDocs. 2019-07-23 09:45:41 +00:00			`.. \|Get Started\| image:: ../_static/get-started.png`
Getting started guides 2017-03-26 22:01:52 +00:00			`.. _Get Started: get-started/index.html`
Initial Sphinx / ReadTheDocs.org configuration 2016-10-23 20:14:24 +00:00
Replace gif images on EN and zh_CN index pages with identical png images for successful building of PDFs on ReadTheDocs. 2019-07-23 09:45:41 +00:00			`.. \|API Reference\| image:: ../_static/api-reference.png`
Getting started guides 2017-03-26 22:01:52 +00:00			`.. _API Reference: api-reference/index.html`
Initial Sphinx / ReadTheDocs.org configuration 2016-10-23 20:14:24 +00:00
Replace gif images on EN and zh_CN index pages with identical png images for successful building of PDFs on ReadTheDocs. 2019-07-23 09:45:41 +00:00			`.. \|H/W Reference\| image:: ../_static/hw-reference.png`
Getting started guides 2017-03-26 22:01:52 +00:00			`.. _H/W Reference: hw-reference/index.html`
Initial Sphinx / ReadTheDocs.org configuration 2016-10-23 20:14:24 +00:00
Replace gif images on EN and zh_CN index pages with identical png images for successful building of PDFs on ReadTheDocs. 2019-07-23 09:45:41 +00:00			`.. \|API Guides\| image:: ../_static/api-guides.png`
Corrected link rendering and additional translations 2018-05-09 05:45:54 +00:00			`.. _API Guides: api-guides/index.html`
Initial Sphinx / ReadTheDocs.org configuration 2016-10-23 20:14:24 +00:00
docs: Add cloud frameworks doc 2019-03-19 08:15:55 +00:00			`.. _Libraries and Frameworks: libraries-and-frameworks/index.html`

Replace gif images on EN and zh_CN index pages with identical png images for successful building of PDFs on ReadTheDocs. 2019-07-23 09:45:41 +00:00			`.. \|Contribute\| image:: ../_static/contribute.png`
Getting started guides 2017-03-26 22:01:52 +00:00			`.. _Contribute: contribute/index.html`
Initial Sphinx / ReadTheDocs.org configuration 2016-10-23 20:14:24 +00:00
Replace gif images on EN and zh_CN index pages with identical png images for successful building of PDFs on ReadTheDocs. 2019-07-23 09:45:41 +00:00			`.. \|Resources\| image:: ../_static/resources.png`
Getting started guides 2017-03-26 22:01:52 +00:00			`.. _Resources: resources.html`
Moved api documentation to new folders / categories 2017-01-16 22:08:35 +00:00
deep-sleep-stub added + TOC outline TOC outline to show overal planned structure 2016-11-05 16:13:44 +00:00
Initial list of Wi-Fi API 2016-10-24 18:44:57 +00:00			`.. toctree::`
Getting started guides 2017-03-26 22:01:52 +00:00			`:hidden:`

docs: update esp32s2 summary page - Refer to the toolchain links on IDF Tools page - Update the wording around v4.1/v4.2 releases - Remove the section about 3 different versions (of S2-beta) - Add link to the list of features maintained externally 2020-02-18 11:06:27 +00:00			`:esp32s2: ESP32-S2 Preview Support <esp32s2>`
docs: Add a temporary index page to get CN docs started 2017-03-24 05:19:34 +00:00			`Get Started <get-started/index>`
Getting started guides 2017-03-26 22:01:52 +00:00			`API Reference <api-reference/index>`
			`H/W Reference <hw-reference/index>`
			`API Guides <api-guides/index>`
docs: Add cloud frameworks doc 2019-03-19 08:15:55 +00:00			`Libraries and Frameworks <libraries-and-frameworks/index>`
Getting started guides 2017-03-26 22:01:52 +00:00			`Contribute <contribute/index>`
docs: Add version-specific include files, version documentation * "git clone" command and a small version header are generated depending on git properties. * Add Versions page with details about each version * Make it clear using master branch is living on the "bleeding edge" 2018-07-25 04:30:15 +00:00			`Versions <versions>`
Getting started guides 2017-03-26 22:01:52 +00:00			`Resources <resources>`
			`Copyrights <COPYRIGHT>`
			`About <about>`
There are now visible links to change between English and Chinese version of documentation. Therefore information on the home page how to switch between languages has been removed. Added 'Download' link to the menu to provide a more visible access to documentation in PDF format for people who prefer to read it offline. 2018-08-12 19:21:35 +00:00			`语言/Languages <languages>`
Docs: Renamed download links to clearly state they are to download documentation. Fixed incorrectly linked documentation build badge. 2018-09-13 22:18:02 +00:00			`Guide Downloads <https://readthedocs.com/projects/espressif-esp-idf/downloads/>`
Restored back original 'zh_CN' version files and updated links between versions 2018-02-03 21:12:13 +00:00
Docs: Mark PDF links as such in the documentation index Nothing worse than clicking what you think is an internal page link and finding a PDF downloading! 2017-02-14 01:56:51 +00:00			* :ref:`genindex`
docs: Add version-specific include files, version documentation * "git clone" command and a small version header are generated depending on git properties. * Add Versions page with details about each version * Make it clear using master branch is living on the "bleeding edge" 2018-07-25 04:30:15 +00:00