esp-idf/docs/index.rst

79 wiersze
1.2 KiB
ReStructuredText

ESP32 Programming Guide
=======================
.. caution::
Until ESP-IDF release 1.0, this documentation is a draft. It is incomplete and may have mistakes. Please mind your step!
Contents:
.. toctree::
:caption: Setup Toolchain
:maxdepth: 1
Windows <windows-setup>
Linux <linux-setup>
Mac OS <macos-setup>
.. Configure - TBA
.. Connect - TBA
.. toctree::
:caption: Build and Flash
:maxdepth: 1
Make <make-project>
Eclipse IDE <eclipse-setup>
.. toctree::
:caption: What Else?
:maxdepth: 1
partition-tables
build_system
openocd
.. toctree::
:caption: API Reference
:maxdepth: 1
Wi-Fi <api/esp_wifi>
Bluetooth <api/bt>
GPIO <api/gpio>
Logging <api/log>
Non-volatile storage <api/nvs>
Virtual filesystem <api/vfs>
Template <api/template>
.. toctree::
:caption: Technical Reference
Technical Reference <http://espressif.com/sites/default/files/documentation/esp32_technical_reference_manual_en.pdf>
.. Resources - TBA
.. toctree::
:caption: Contribute
:maxdepth: 1
contributing
documenting-code
contributor-agreement
.. toctree::
:caption: Legal
:maxdepth: 1
COPYRIGHT
.. About - TBA
Indices
=======
* :ref:`genindex`
* :ref:`search`