Moved api documentation to new folders / categories

docs/api/bluetooth/index.rst

@@ -1,9 +1,10 @@
-Bluetooth
+Bluetooth API
-=========
+*************
 
 .. toctree::
-   :caption: Bluetooth APIs
+   :maxdepth: 2
 
    Bluetooth Controller && VHCI <controller_vhci>
    Bluetooth Common <bt_common>
    Bluetooth LE <bt_le>
+

docs/api/ethernet/index.rst

@@ -0,0 +1,8 @@
+Ethernet API
+************
+
+.. toctree::
+   :maxdepth: 1
+
+   Ethernet <esp_eth>
+

docs/api/peripherals/index.rst

@@ -0,0 +1,16 @@
+Peripherals API
+***************
+
+.. toctree::
+   :maxdepth: 1
+
+   GPIO <gpio>
+   UART <uart>
+   I2C <i2c>
+   SPI Master <spi_master>
+   Timer <timer>
+   Pulse Counter <pcnt>
+   Sigma-delta Modulation <sigmadelta>
+   LED Control <ledc>
+   Remote Control <rmt>
+

docs/api/protocols/index.rst

@@ -0,0 +1,8 @@
+Protocols API
+*************
+
+.. toctree::
+   :maxdepth: 1
+
+   mDNS <mdns>
+

docs/api/storage/index.rst

@@ -0,0 +1,12 @@
+Storage API
+***********
+
+.. toctree::
+   :maxdepth: 1
+
+   SPI Flash and Partition APIs <spi_flash>
+   SD/MMC <sdmmc>
+   Non-Volatile Storage <nvs_flash>
+   Virtual Filesystem <vfs>
+   FAT Filesystem <fatfs>
+

docs/api/system/index.rst

@@ -0,0 +1,13 @@
+System API
+**********
+
+.. toctree::
+   :maxdepth: 1
+
+   Memory Allocation <mem_alloc>
+   Interrupt Allocation <intr_alloc>
+   Watchdogs <wdts>
+   OTA <ota>
+   Deep Sleep <deep_sleep>
+   Logging <log>
+

docs/api/wifi/index.rst

@@ -0,0 +1,8 @@
+Wi-Fi API
+*********
+
+.. toctree::
+   :maxdepth: 1
+
+   Wi-Fi <esp_wifi>
+   Smart Config <esp_smartconfig>

docs/index.rst

@@ -26,118 +26,46 @@ Contents:
 .. toctree::
    :caption: What Else?
    :maxdepth: 1
-   
-   General Notes <general-notes>
-   partition-tables
-   build_system
-   openocd
-   core_dump
-   Flash encryption <security/flash-encryption>
-   Secure Boot <security/secure-boot>
-   ULP coprocessor <api/ulp.rst>
 
-.. API Reference
+   General Notes <general-notes>
-   ..
+   Build System <build_system>
-   Table of Contents Outline
+   Debugging <openocd>
-   ..
+   ESP32 Core Dump <core_dump>
-   1. System - TBA
+   Partition Tables <partition-tables>
-     1.1. Fundamentals of multiprocessor programming with FreeRTOS - TBA
+   Flash Encryption <security/flash-encryption>
-     1.2. Application startup flow - TBA
+   Secure Boot <security/secure-boot>
-     1.3. Flash encryption and secure boot: how they work and APIs
+   Deep Sleep Wake Stubs <deep-sleep-stub>
-     1.4. Lower Power Coprocessor - TBA
+   ULP Coprocessor <ulp>
-     1.5. Watchdogs <api/wdts>
-     1.6. Memory allocation <api/mem_alloc>
-     1.7. ...
-   2. Memory - 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
-     6.5. I2C - TBA
-     6.6. I2S - TBA
-     6.7. SPI - <api/spi_master>
-     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
+   :maxdepth: 2
 
-   Wi-Fi <api/esp_wifi>
+   Wi-Fi <api/wifi/index>
-   Smart Config <api/esp_smartconfig>
+   Bluetooth <api/bluetooth/index>
-   Bluetooth <api/bt>
+   Ethernet <api/ethernet/index>
-   Watchdogs <api/wdts>
+   Peripherals <api/peripherals/index>
-   OTA <api/ota>
+   System <api/system/index>
-   GPIO <api/gpio>
+   Storage <api/storage/index>
-   UART <api/uart>
+   Protocols <api/protocols/index>
-   LED Control <api/ledc>
-   Remote Control <api/rmt>
-   Timer <api/timer>
-   I2C <api/i2c>
-   Pulse Counter <api/pcnt>
-   Sigma-delta Modulation <api/sigmadelta>
-   SD/MMC <api/sdmmc>
-   SPI Flash and Partition APIs <api/spi_flash>
-   SPI Master API <api/spi_master>
-   Logging <api/log>
-   Non-Volatile Storage <api/nvs_flash>
-   Virtual Filesystem <api/vfs>
-   FAT Filesystem <api/fatfs>
-   Ethernet <api/esp_eth>
-   Interrupt Allocation <api/intr_alloc>
-   Memory Allocation <api/mem_alloc>
-   Deep Sleep <api/deep_sleep>
-   deep-sleep-stub
-
-   mDNS <api/mdns>
-   Template <api/template>
 
 .. toctree::
-   :caption: Technical Reference
+   :caption: Hardware Reference
 
-   Technical Reference <http://espressif.com/sites/default/files/documentation/esp32_technical_reference_manual_en.pdf>
+   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>
-.. Resources - TBA
+   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
 
-   contributing
+   Contributions Guide <contributing>
    Style Guide <style-guide>
-   documenting-code
+   Documenting Code <documenting-code>
-   contributor-agreement
+   API Template <api/template>
+   Contributor Agreement <contributor-agreement>
 
 .. toctree::
    :caption: Legal
@@ -147,8 +75,7 @@ Contents:
 
  
 Indices
--------
+=======
 
 * :ref:`genindex`
-* :ref:`search`