ESP-IDF 编程指南
=========================

:link_to_translation:`en:[English]`

.. only:: fast_build

    .. warning::

        快速预览中不包括 API 函数文档。如需生成完整的文档，请在 MR 中添加 docs_full 标签。

这里是乐鑫 IoT 开发框架 (`esp-idf <https://github.com/espressif/esp-idf>`_) 的文档中心。ESP-IDF 是 `ESP32、ESP32-S、ESP32-C、ESP32-H 和 ESP32-P <https://www.espressif.com/en/products/socs>`_ 系列芯片的官方开发框架。

.. only:: html

    本文档仅包含针对 {IDF_TARGET_NAME} 芯片的 ESP-IDF 使用。如需了解其他芯片，请在页面左上方的下拉菜单中选择你的目标芯片。

.. only:: latex

    本文档仅包含针对 {IDF_TARGET_NAME} 芯片的 ESP-IDF 使用。

.. only:: esp32c2

    .. important::

        {IDF_TARGET_NAME} 芯片系列合集当前仅包含 ESP8684 一个系列，因此本文中出现的 {IDF_TARGET_NAME} 指的就是 ESP8684 芯片系列。


==================  ==================  ==================
|快速入门|_          |API 参考|_         |API 指南|_
------------------  ------------------  ------------------
`快速入门`_          `API 参考`_         `API 指南`_
==================  ==================  ==================

.. |快速入门| image:: ../_static/get-started.png
.. _快速入门: get-started/index.html

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

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

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


.. toctree::
   :hidden:

   get-started/index
   api-reference/index
   hw-reference/index
   api-guides/index
   migration-guides/index
   security/index
   libraries-and-frameworks/index
   contribute/index
   versions
   resources
   COPYRIGHT
   about
   languages
