esp-idf/docs/zh_CN/index.rst
Marius Vikhammer bdfda351bd build docs: enable building of S3 docs
* Added suport for building esp32s3 docs
 * Fixed all related warnings
 * Activated building of S3 docs for build HTML fast CI job
2021-06-09 09:30:36 +08:00

74 lines
2.4 KiB
ReStructuredText

ESP-IDF 编程指南
=========================
:link_to_translation:`en:[English]`
.. only:: fast_build
.. warning::
The function API documentation is excluded from the preview. Add docs_full label to the MR to generate the complete documentation.
这里是乐鑫 IoT 开发框架 (`esp-idf <https://github.com/espressif/esp-idf>`_) 的文档中心。ESP-IDF 是 `ESP32、ESP32-S 和 ESP32-C <https://www.espressif.com/en/products/hardware/socs>`_ 系列芯片的官方开发框架。
.. only:: html
本文档仅包含针对 {IDF_TARGET_NAME} 芯片的 ESP-IDF 使用。如需了解其他芯片,请在页面左上方的下拉菜单中选择您的目标芯片。
.. only:: latex
本文档仅包含针对 {IDF_TARGET_NAME} 芯片的 ESP-IDF 使用。
.. only:: esp32s3
.. warning::
ESP32-S3 的相关文档尚未全部更新完毕。
================== ================== ==================
|快速入门|_ |API 参考|_ |H/W 参考|_
------------------ ------------------ ------------------
`快速入门`_ `API 参考`_ `H/W 参考`_
------------------ ------------------ ------------------
|API 指南|_ |贡献代码|_ |相关资源|_
------------------ ------------------ ------------------
`API 指南`_ `贡献代码`_ `相关资源`_
================== ================== ==================
.. |快速入门| image:: ../_static/get-started.png
.. _快速入门: get-started/index.html
.. |API 参考| image:: ../_static/api-reference.png
.. _API 参考: api-reference/index.html
.. |H/W 参考| image:: ../_static/hw-reference.png
.. _H/W 参考: hw-reference/index.html
.. |API 指南| image:: ../_static/api-guides.png
.. _API 指南: api-guides/index.html
.. _Libraries and Frameworks: libraries-and-frameworks/index.html
.. |贡献代码| image:: ../_static/contribute.png
.. _贡献代码: contribute/index.html
.. |相关资源| image:: ../_static/resources.png
.. _相关资源: resources.html
.. toctree::
:hidden:
快速入门 <get-started/index>
API 参考 <api-reference/index>
H/W 参考 <hw-reference/index>
API 指南 <api-guides/index>
Libraries and Frameworks <libraries-and-frameworks/index>
贡献代码 <contribute/index>
版本 <versions>
相关资源 <resources>
版权 <COPYRIGHT>
关于 <about>
Languages/语言 <languages>
* :ref:`genindex`