mirror of
https://github.com/espressif/esp-idf.git
synced 2024-10-05 20:47:46 -04:00
30c2fca25a
Organize examples and API documentation - supplement to !430 This supplement to !430, both intended to replace bulky !421. 1. Fixed broken links 2. Added links to available examples in API documentation, where missing 3. Updated links to point directly to example folder (to show README.md with example description) 4. Added README.md in docs folder info to point reader to ReadTheDocs instead of doc sources, ref. https://github.com/espressif/esp-idf/issues/243 5. Fixed some typo errors / Sphinx warnings 6. Fixed memory leak in example, ref. https://github.com/espressif/esp-idf/issues/209 See merge request !440
81 lines
2.1 KiB
ReStructuredText
81 lines
2.1 KiB
ReStructuredText
ESP-IDF Programming Guide
|
|
=========================
|
|
|
|
This is the documentation for Espressif IoT Developement 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.
|
|
|
|
|
|
Contents:
|
|
|
|
.. toctree::
|
|
:caption: Setup Toolchain
|
|
:maxdepth: 1
|
|
|
|
Windows <windows-setup>
|
|
Linux <linux-setup>
|
|
Mac OS <macos-setup>
|
|
|
|
.. Connect - TBA
|
|
|
|
.. toctree::
|
|
:caption: Build and Flash
|
|
:maxdepth: 1
|
|
|
|
Make <make-project>
|
|
Eclipse IDE <eclipse-setup>
|
|
|
|
.. toctree::
|
|
:caption: What Else?
|
|
:maxdepth: 1
|
|
|
|
General Notes <general-notes>
|
|
Build System <build-system>
|
|
Debugging <openocd>
|
|
ESP32 Core Dump <core_dump>
|
|
Partition Tables <partition-tables>
|
|
Flash Encryption <security/flash-encryption>
|
|
Secure Boot <security/secure-boot>
|
|
Deep Sleep Wake Stubs <deep-sleep-stub>
|
|
ULP Coprocessor <ulp>
|
|
Unit Testing <unit-tests>
|
|
|
|
.. toctree::
|
|
:caption: API Reference
|
|
:maxdepth: 2
|
|
|
|
Wi-Fi <api/wifi/index>
|
|
Bluetooth <api/bluetooth/index>
|
|
Ethernet <api/ethernet/index>
|
|
Peripherals <api/peripherals/index>
|
|
System <api/system/index>
|
|
Storage <api/storage/index>
|
|
Protocols <api/protocols/index>
|
|
|
|
.. toctree::
|
|
:caption: Hardware Reference
|
|
|
|
Technical Reference Manual <http://espressif.com/sites/default/files/documentation/esp32_technical_reference_manual_en.pdf>
|
|
Pin List and Functions <http://espressif.com/sites/default/files/documentation/esp32_chip_pin_list_en.pdf>
|
|
Chip Pinout <http://espressif.com/sites/default/files/documentation/esp32_pinout_v1_0.pdf>
|
|
Silicon Errata <http://espressif.com/sites/default/files/documentation/eco_and_workarounds_for_bugs_in_esp32_en.pdf>
|
|
|
|
.. toctree::
|
|
:caption: Contribute
|
|
:maxdepth: 1
|
|
|
|
Contributions Guide <contributing>
|
|
Style Guide <style-guide>
|
|
Documenting Code <documenting-code>
|
|
API Template <api/template>
|
|
Contributor Agreement <contributor-agreement>
|
|
|
|
.. toctree::
|
|
:caption: Legal
|
|
:maxdepth: 1
|
|
|
|
COPYRIGHT
|
|
|
|
|
|
Indices
|
|
=======
|
|
|
|
* :ref:`genindex` |