1ESP-IDF Programming Guide
2=========================
3:link_to_translation:`zh_CN:[中文]`
4
5.. only:: fast_build
6
7    .. warning::
8
9        The function API documentation is excluded from the preview. Add docs_full label to the MR to generate the complete documentation.
10
11This 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, ESP32-S and ESP32-C Series SoCs <https://www.espressif.com/en/products/hardware/socs>`_.
12
13.. only:: html
14
15    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.
16
17.. only:: latex
18
19    This document describes using ESP-IDF with the {IDF_TARGET_NAME} SoC.
20
21==================  ==================  ==================
22|Get Started|_      |API Reference|_    |H/W Reference|_
23------------------  ------------------  ------------------
24`Get Started`_      `API Reference`_    `H/W Reference`_
25------------------  ------------------  ------------------
26|API Guides|_       |Contribute|_       |Resources|_
27------------------  ------------------  ------------------
28`API Guides`_       `Contribute`_       `Resources`_
29==================  ==================  ==================
30
31.. |Get Started| image:: ../_static/get-started.png
32.. _Get Started: get-started/index.html
33
34.. |API Reference| image:: ../_static/api-reference.png
35.. _API Reference: api-reference/index.html
36
37.. |H/W Reference| image:: ../_static/hw-reference.png
38.. _H/W Reference: hw-reference/index.html
39
40.. |API Guides| image:: ../_static/api-guides.png
41.. _API Guides: api-guides/index.html
42
43.. _Libraries and Frameworks: libraries-and-frameworks/index.html
44
45.. |Contribute| image:: ../_static/contribute.png
46.. _Contribute: contribute/index.html
47
48.. |Resources| image:: ../_static/resources.png
49.. _Resources: resources.html
50
51
52.. toctree::
53   :hidden:
54
55   Get Started <get-started/index>
56   API Reference <api-reference/index>
57   H/W Reference <hw-reference/index>
58   API Guides <api-guides/index>
59   Libraries and Frameworks <libraries-and-frameworks/index>
60   Contribute <contribute/index>
61   Versions <versions>
62   Resources <resources>
63   Copyrights <COPYRIGHT>
64   About <about>
65   语言/Languages <languages>
66
67* :ref:`genindex`
68
69
70
71