diff --git a/docs/index.rst b/docs/index.rst index c973950615..42be69ee0c 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -5,7 +5,6 @@ ESP32 Programming Guide Until ESP-IDF release 1.0, this documentation is a draft. It is incomplete and may have mistakes. Please mind your step! - Contents: .. toctree:: @@ -16,8 +15,6 @@ Contents: Linux Mac OS -.. Configure - TBA - .. Connect - TBA .. toctree:: @@ -35,16 +32,74 @@ Contents: build_system openocd +.. API Reference + .. + Table of Contents Outline + .. + 1. System - TBA + 1.1. Fundamentals of multiprocessor programming with FreeRTOS - TBA + 1.2. Application startup flow - TBA + 1.3. Flash encryption and secure boot: how they work and APIs - TBA + 1.4. Lower Power Coprocessor - TBA + 1.5. Watchdogs + 1.6. ... + 2. Memeory - TBA + 2.1. Memory layout of the application (IRAM/IROM, limitations of each) - TBA + 2.2. Flash layout and partitions - TBA + 2.3. Flash access APIs - TBA + 2.4. Partition APIs - TBA + 2.5. OTA mechanism (app partitions, OTA partition) and APIs - TBA + 2.6. ... + 3. Wi-Fi + 4. Bluetooth + 4.1. BT Classic - TBA + 4.2. BLE + 5. Ethernet - TBA + 6. Interfaces + 6.1. GPIO + 6.2. ADC - TBA + 6.3. DAC - TBA + 6.4. UART - TBA + 6.5. I2C - TBA + 6.6. I2S - TBA + 6.7. SPI - TBA + 6.8. CAN - TBA + 6.9. SD Controller - TBA + 6.10. Infrared - TBA + 6.11. Pulse Counter - TBA + 6.12. PWM - TBA + 6.13. LED PWM + 6.14. ... + 7. Sensors - TBA + 7.1. Hall Sensor - TBA + 7.2. Temperature Sensor - TBA + 7.3. Touch Sensor - TBA + 8. Protocols - TBA + 9. Components + 9.1. Logging + 9.2 Non-Volatile Storage + 9.3 Virtual Filesystem + 9.3. Http sever - TBA + 10. Applications - TBA + .. + API Dcoumentation Teamplate + .. + .. toctree:: :caption: API Reference :maxdepth: 1 Wi-Fi Bluetooth + GPIO + LED Control + Logging - Non-volatile storage - Virtual filesystem + Non-Volatile Storage + Virtual Filesystem + deep-sleep-stub + Template .. toctree:: @@ -76,3 +131,4 @@ Indices * :ref:`genindex` * :ref:`search` +