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.

.. note::
   This is documentation for the the CMake-based build system which is currently in preview release. The documentation may have gaps, and you may encounter bugs (please report either of these). To view documentation for the older GNU Make based build system, switch versions to the 'latest' master branch or a stable release.

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>
   API Reference <api-reference/index>
   H/W Reference <hw-reference/index>
   API Guides <api-guides/index>
   Contribute <contribute/index>
   Resources <resources>
   Copyrights <COPYRIGHT>
   About <about>
   [语言/Languages] <languages>
   
* :ref:`genindex`