OVMS3-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 <https://espressif.com/en/products/hardware/esp32/overview>`_ chip.

The documentation has different language versions (:link_to_translation:`en:English`, :link_to_translation:`zh_CN:中文版`, :doc:`How to switch between languages? <languages>`). However, please refer to the English version if there is any discrepancy.

==================  ==================  ==================
|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.gif
.. _Get Started: get-started/index.html

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

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

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

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

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


.. toctree::
   :hidden:

   Get Started <get-started/index>
   Get Started (CMake Preview) <get-started-cmake/index>
   API Reference <api-reference/index>
   H/W Reference <hw-reference/index>
   API Guides <api-guides/index>
   Contribute <contribute/index>
   Versions <versions>
   Resources <resources>
   Copyrights <COPYRIGHT>
   About <about>
   [语言/Languages] <languages>
   
* :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
Getting started guides 2017-03-26 22:01:52 +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 <https://espressif.com/en/products/hardware/esp32/overview>`_ chip.
doc: Index clean up 2016-11-16 19:17:44 +00:00
docs: add language link to easily change to Chinese version 2018-03-14 09:03:56 +00:00			The documentation has different language versions (:link_to_translation:`en:English`, :link_to_translation:`zh_CN:中文版`, :doc:`How to switch between languages? <languages>`). However, please refer to the English version if there is any discrepancy.

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`_
			`================== ================== ==================`


			`.. \|Get Started\| image:: ../_static/get-started.gif`
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
Restored back original 'zh_CN' version files and updated links between versions 2018-02-03 21:12:13 +00:00			`.. \|API Reference\| image:: ../_static/api-reference.gif`
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
Restored back original 'zh_CN' version files and updated links between versions 2018-02-03 21:12:13 +00:00			`.. \|H/W Reference\| image:: ../_static/hw-reference.gif`
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
Corrected link rendering and additional translations 2018-05-09 05:45:54 +00:00			`.. \|API Guides\| image:: ../_static/api-guides.gif`
			`.. _API Guides: api-guides/index.html`
Initial Sphinx / ReadTheDocs.org configuration 2016-10-23 20:14:24 +00:00
Restored back original 'zh_CN' version files and updated links between versions 2018-02-03 21:12:13 +00:00			`.. \|Contribute\| image:: ../_static/contribute.gif`
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
Restored back original 'zh_CN' version files and updated links between versions 2018-02-03 21:12:13 +00:00			`.. \|Resources\| image:: ../_static/resources.gif`
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: Add a temporary index page to get CN docs started 2017-03-24 05:19:34 +00:00			`Get Started <get-started/index>`
docs: Copy CMake docs to a separate set of directories Required first step before merging back to mainline. 2018-08-08 07:58:00 +00:00			`Get Started (CMake Preview) <get-started-cmake/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>`
			`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>`
docs: add language link to easily change to Chinese version 2018-03-14 09:03:56 +00:00			`[语言/Languages] <languages>`
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