esp-idf/docs/index.rst

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>
   IDF Monitor <idf-monitor>

.. 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 (PDF) <http://espressif.com/sites/default/files/documentation/esp32_technical_reference_manual_en.pdf>
   Pin List and Functions (PDF) <http://espressif.com/sites/default/files/documentation/esp32_chip_pin_list_en.pdf>
   Chip Pinout (PDF) <http://espressif.com/sites/default/files/documentation/esp32_pinout_v1_0.pdf>
   Silicon Errata (PDF) <http://espressif.com/sites/default/files/documentation/eco_and_workarounds_for_bugs_in_esp32_en.pdf>
   Modules and Boards <modules-and-boards>
   
.. 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`
docs: update index, improve structure of the readme 2017-01-15 12:48:47 -05:00			`ESP-IDF Programming Guide`
			`=========================`
Initial Sphinx / ReadTheDocs.org configuration 2016-10-23 16:14:24 -04:00
docs: update index, improve structure of the readme 2017-01-15 12:48:47 -05:00			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.
doc: Index clean up 2016-11-16 14:17:44 -05:00

Initial list of Wi-Fi API 2016-10-24 14:44:57 -04:00			`Contents:`
Initial Sphinx / ReadTheDocs.org configuration 2016-10-23 16:14:24 -04:00
Initial list of Wi-Fi API 2016-10-24 14:44:57 -04:00			`.. toctree::`
			`:caption: Setup Toolchain`
			`:maxdepth: 1`
Initial Sphinx / ReadTheDocs.org configuration 2016-10-23 16:14:24 -04:00
Initial list of Wi-Fi API 2016-10-24 14:44:57 -04:00			`Windows <windows-setup>`
			`Linux <linux-setup>`
			`Mac OS <macos-setup>`
Initial Sphinx / ReadTheDocs.org configuration 2016-10-23 16:14:24 -04:00
Initial list of Wi-Fi API 2016-10-24 14:44:57 -04:00			`.. Connect - TBA`
Initial Sphinx / ReadTheDocs.org configuration 2016-10-23 16:14:24 -04:00
Initial list of Wi-Fi API 2016-10-24 14:44:57 -04:00			`.. toctree::`
			`:caption: Build and Flash`
			`:maxdepth: 1`
Initial Sphinx / ReadTheDocs.org configuration 2016-10-23 16:14:24 -04:00
Make section 2016-10-25 15:28:21 -04:00			`Make <make-project>`
Initial list of Wi-Fi API 2016-10-24 14:44:57 -04:00			`Eclipse IDE <eclipse-setup>`
tools: New idf_monitor 'make monitor' tool for smarter monitor output 2017-03-07 17:15:19 -05:00			`IDF Monitor <idf-monitor>`
Initial Sphinx / ReadTheDocs.org configuration 2016-10-23 16:14:24 -04:00
			`.. toctree::`
API template - reflected template in other DRAFT API dcouments - DRAFT of Bluetooth API - link fixes in CONTRIBUTING.rst 2016-10-26 15:08:36 -04:00			`:caption: What Else?`
Initial Sphinx / ReadTheDocs.org configuration 2016-10-23 16:14:24 -04:00			`:maxdepth: 1`
Moved api documentation to new folders / categories 2017-01-16 17:08:35 -05:00
docs: add description of ESP-IDF application startup flow and memory layout 2016-11-14 02:40:54 -05:00			`General Notes <general-notes>`
Typo corrections 2017-01-17 15:12:54 -05:00			`Build System <build-system>`
Moved api documentation to new folders / categories 2017-01-16 17:08:35 -05:00			`Debugging <openocd>`
			`ESP32 Core Dump <core_dump>`
			`Partition Tables <partition-tables>`
			`Flash Encryption <security/flash-encryption>`
Secure boot: Documentation tweaks 2016-11-10 23:40:29 -05:00			`Secure Boot <security/secure-boot>`
Moved api documentation to new folders / categories 2017-01-16 17:08:35 -05:00			`Deep Sleep Wake Stubs <deep-sleep-stub>`
			`ULP Coprocessor <ulp>`
esp32: add unit testing doc 2016-12-05 04:29:12 -05:00			`Unit Testing <unit-tests>`
deep-sleep-stub added + TOC outline TOC outline to show overal planned structure 2016-11-05 12:13:44 -04:00
Initial list of Wi-Fi API 2016-10-24 14:44:57 -04:00			`.. toctree::`
			`:caption: API Reference`
Moved api documentation to new folders / categories 2017-01-16 17:08:35 -05:00			`:maxdepth: 2`
Initial Sphinx / ReadTheDocs.org configuration 2016-10-23 16:14:24 -04:00
Moved api documentation to new folders / categories 2017-01-16 17:08:35 -05:00			`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>`
Initial Sphinx / ReadTheDocs.org configuration 2016-10-23 16:14:24 -04:00
			`.. toctree::`
Moved api documentation to new folders / categories 2017-01-16 17:08:35 -05:00			`:caption: Hardware Reference`
Initial Sphinx / ReadTheDocs.org configuration 2016-10-23 16:14:24 -04:00
Docs: Mark PDF links as such in the documentation index Nothing worse than clicking what you think is an internal page link and finding a PDF downloading! 2017-02-13 20:56:51 -05:00			`Technical Reference Manual (PDF) <http://espressif.com/sites/default/files/documentation/esp32_technical_reference_manual_en.pdf>`
			`Pin List and Functions (PDF) <http://espressif.com/sites/default/files/documentation/esp32_chip_pin_list_en.pdf>`
			`Chip Pinout (PDF) <http://espressif.com/sites/default/files/documentation/esp32_pinout_v1_0.pdf>`
			`Silicon Errata (PDF) <http://espressif.com/sites/default/files/documentation/eco_and_workarounds_for_bugs_in_esp32_en.pdf>`
doc: add dev module and boards by Espressif 2017-03-06 15:44:10 -05:00			`Modules and Boards <modules-and-boards>`
Initial Sphinx / ReadTheDocs.org configuration 2016-10-23 16:14:24 -04:00
			`.. toctree::`
			`:caption: Contribute`
			`:maxdepth: 1`

Moved api documentation to new folders / categories 2017-01-16 17:08:35 -05:00			`Contributions Guide <contributing>`
New items to documentation TOC - Style Guide - UART API 2016-11-10 16:47:29 -05:00			`Style Guide <style-guide>`
Moved api documentation to new folders / categories 2017-01-16 17:08:35 -05:00			`Documenting Code <documenting-code>`
			`API Template <api/template>`
			`Contributor Agreement <contributor-agreement>`
Initial Sphinx / ReadTheDocs.org configuration 2016-10-23 16:14:24 -04:00
			`.. toctree::`
Initial list of Wi-Fi API 2016-10-24 14:44:57 -04:00			`:caption: Legal`
Initial Sphinx / ReadTheDocs.org configuration 2016-10-23 16:14:24 -04:00			`:maxdepth: 1`

			`COPYRIGHT`

Make section 2016-10-25 15:28:21 -04:00
			`Indices`
Moved api documentation to new folders / categories 2017-01-16 17:08:35 -05:00			`=======`
Initial Sphinx / ReadTheDocs.org configuration 2016-10-23 16:14:24 -04:00
Docs: Mark PDF links as such in the documentation index Nothing worse than clicking what you think is an internal page link and finding a PDF downloading! 2017-02-13 20:56:51 -05:00			* :ref:`genindex`