diff --git a/docs/api/bt_common.rst b/docs/api/bluetooth/bt_common.rst similarity index 100% rename from docs/api/bt_common.rst rename to docs/api/bluetooth/bt_common.rst diff --git a/docs/api/bt_le.rst b/docs/api/bluetooth/bt_le.rst similarity index 100% rename from docs/api/bt_le.rst rename to docs/api/bluetooth/bt_le.rst diff --git a/docs/api/controller_vhci.rst b/docs/api/bluetooth/controller_vhci.rst similarity index 100% rename from docs/api/controller_vhci.rst rename to docs/api/bluetooth/controller_vhci.rst diff --git a/docs/api/esp_blufi.rst b/docs/api/bluetooth/esp_blufi.rst similarity index 100% rename from docs/api/esp_blufi.rst rename to docs/api/bluetooth/esp_blufi.rst diff --git a/docs/api/esp_bt_defs.rst b/docs/api/bluetooth/esp_bt_defs.rst similarity index 100% rename from docs/api/esp_bt_defs.rst rename to docs/api/bluetooth/esp_bt_defs.rst diff --git a/docs/api/esp_bt_device.rst b/docs/api/bluetooth/esp_bt_device.rst similarity index 100% rename from docs/api/esp_bt_device.rst rename to docs/api/bluetooth/esp_bt_device.rst diff --git a/docs/api/esp_bt_main.rst b/docs/api/bluetooth/esp_bt_main.rst similarity index 100% rename from docs/api/esp_bt_main.rst rename to docs/api/bluetooth/esp_bt_main.rst diff --git a/docs/api/esp_gap_ble.rst b/docs/api/bluetooth/esp_gap_ble.rst similarity index 100% rename from docs/api/esp_gap_ble.rst rename to docs/api/bluetooth/esp_gap_ble.rst diff --git a/docs/api/esp_gatt_defs.rst b/docs/api/bluetooth/esp_gatt_defs.rst similarity index 100% rename from docs/api/esp_gatt_defs.rst rename to docs/api/bluetooth/esp_gatt_defs.rst diff --git a/docs/api/esp_gattc.rst b/docs/api/bluetooth/esp_gattc.rst similarity index 100% rename from docs/api/esp_gattc.rst rename to docs/api/bluetooth/esp_gattc.rst diff --git a/docs/api/esp_gatts.rst b/docs/api/bluetooth/esp_gatts.rst similarity index 100% rename from docs/api/esp_gatts.rst rename to docs/api/bluetooth/esp_gatts.rst diff --git a/docs/api/bt.rst b/docs/api/bluetooth/index.rst similarity index 71% rename from docs/api/bt.rst rename to docs/api/bluetooth/index.rst index 2eae5dd4c..fffe67442 100644 --- a/docs/api/bt.rst +++ b/docs/api/bluetooth/index.rst @@ -1,9 +1,10 @@ -Bluetooth -========= +Bluetooth API +************* .. toctree:: - :caption: Bluetooth APIs + :maxdepth: 2 Bluetooth Controller && VHCI Bluetooth Common Bluetooth LE + diff --git a/docs/api/esp_eth.rst b/docs/api/ethernet/esp_eth.rst similarity index 100% rename from docs/api/esp_eth.rst rename to docs/api/ethernet/esp_eth.rst diff --git a/docs/api/ethernet/index.rst b/docs/api/ethernet/index.rst new file mode 100644 index 000000000..aeb0137c5 --- /dev/null +++ b/docs/api/ethernet/index.rst @@ -0,0 +1,8 @@ +Ethernet API +************ + +.. toctree:: + :maxdepth: 1 + + Ethernet + diff --git a/docs/api/gpio.rst b/docs/api/peripherals/gpio.rst similarity index 100% rename from docs/api/gpio.rst rename to docs/api/peripherals/gpio.rst diff --git a/docs/api/i2c.rst b/docs/api/peripherals/i2c.rst similarity index 100% rename from docs/api/i2c.rst rename to docs/api/peripherals/i2c.rst diff --git a/docs/api/peripherals/index.rst b/docs/api/peripherals/index.rst new file mode 100644 index 000000000..9ea0c41ab --- /dev/null +++ b/docs/api/peripherals/index.rst @@ -0,0 +1,16 @@ +Peripherals API +*************** + +.. toctree:: + :maxdepth: 1 + + GPIO + UART + I2C + SPI Master + Timer + Pulse Counter + Sigma-delta Modulation + LED Control + Remote Control + diff --git a/docs/api/ledc.rst b/docs/api/peripherals/ledc.rst similarity index 100% rename from docs/api/ledc.rst rename to docs/api/peripherals/ledc.rst diff --git a/docs/api/pcnt.rst b/docs/api/peripherals/pcnt.rst similarity index 100% rename from docs/api/pcnt.rst rename to docs/api/peripherals/pcnt.rst diff --git a/docs/api/rmt.rst b/docs/api/peripherals/rmt.rst similarity index 100% rename from docs/api/rmt.rst rename to docs/api/peripherals/rmt.rst diff --git a/docs/api/sigmadelta.rst b/docs/api/peripherals/sigmadelta.rst similarity index 100% rename from docs/api/sigmadelta.rst rename to docs/api/peripherals/sigmadelta.rst diff --git a/docs/api/spi_master.rst b/docs/api/peripherals/spi_master.rst similarity index 100% rename from docs/api/spi_master.rst rename to docs/api/peripherals/spi_master.rst diff --git a/docs/api/timer.rst b/docs/api/peripherals/timer.rst similarity index 100% rename from docs/api/timer.rst rename to docs/api/peripherals/timer.rst diff --git a/docs/api/uart.rst b/docs/api/peripherals/uart.rst similarity index 100% rename from docs/api/uart.rst rename to docs/api/peripherals/uart.rst diff --git a/docs/api/protocols/index.rst b/docs/api/protocols/index.rst new file mode 100644 index 000000000..632bd141d --- /dev/null +++ b/docs/api/protocols/index.rst @@ -0,0 +1,8 @@ +Protocols API +************* + +.. toctree:: + :maxdepth: 1 + + mDNS + diff --git a/docs/api/mdns.rst b/docs/api/protocols/mdns.rst similarity index 100% rename from docs/api/mdns.rst rename to docs/api/protocols/mdns.rst diff --git a/docs/api/fatfs.rst b/docs/api/storage/fatfs.rst similarity index 100% rename from docs/api/fatfs.rst rename to docs/api/storage/fatfs.rst diff --git a/docs/api/storage/index.rst b/docs/api/storage/index.rst new file mode 100644 index 000000000..30fb2088c --- /dev/null +++ b/docs/api/storage/index.rst @@ -0,0 +1,12 @@ +Storage API +*********** + +.. toctree:: + :maxdepth: 1 + + SPI Flash and Partition APIs + SD/MMC + Non-Volatile Storage + Virtual Filesystem + FAT Filesystem + diff --git a/docs/api/nvs_flash.rst b/docs/api/storage/nvs_flash.rst similarity index 100% rename from docs/api/nvs_flash.rst rename to docs/api/storage/nvs_flash.rst diff --git a/docs/api/sdmmc.rst b/docs/api/storage/sdmmc.rst similarity index 100% rename from docs/api/sdmmc.rst rename to docs/api/storage/sdmmc.rst diff --git a/docs/api/spi_flash.rst b/docs/api/storage/spi_flash.rst similarity index 100% rename from docs/api/spi_flash.rst rename to docs/api/storage/spi_flash.rst diff --git a/docs/api/vfs.rst b/docs/api/storage/vfs.rst similarity index 100% rename from docs/api/vfs.rst rename to docs/api/storage/vfs.rst diff --git a/docs/api/deep_sleep.rst b/docs/api/system/deep_sleep.rst similarity index 100% rename from docs/api/deep_sleep.rst rename to docs/api/system/deep_sleep.rst diff --git a/docs/api/system/index.rst b/docs/api/system/index.rst new file mode 100644 index 000000000..6bbd7c10c --- /dev/null +++ b/docs/api/system/index.rst @@ -0,0 +1,13 @@ +System API +********** + +.. toctree:: + :maxdepth: 1 + + Memory Allocation + Interrupt Allocation + Watchdogs + OTA + Deep Sleep + Logging + diff --git a/docs/api/intr_alloc.rst b/docs/api/system/intr_alloc.rst similarity index 100% rename from docs/api/intr_alloc.rst rename to docs/api/system/intr_alloc.rst diff --git a/docs/api/log.rst b/docs/api/system/log.rst similarity index 100% rename from docs/api/log.rst rename to docs/api/system/log.rst diff --git a/docs/api/mem_alloc.rst b/docs/api/system/mem_alloc.rst similarity index 100% rename from docs/api/mem_alloc.rst rename to docs/api/system/mem_alloc.rst diff --git a/docs/api/ota.rst b/docs/api/system/ota.rst similarity index 100% rename from docs/api/ota.rst rename to docs/api/system/ota.rst diff --git a/docs/api/wdts.rst b/docs/api/system/wdts.rst similarity index 100% rename from docs/api/wdts.rst rename to docs/api/system/wdts.rst diff --git a/docs/api/esp_smartconfig.rst b/docs/api/wifi/esp_smartconfig.rst similarity index 100% rename from docs/api/esp_smartconfig.rst rename to docs/api/wifi/esp_smartconfig.rst diff --git a/docs/api/esp_wifi.rst b/docs/api/wifi/esp_wifi.rst similarity index 100% rename from docs/api/esp_wifi.rst rename to docs/api/wifi/esp_wifi.rst diff --git a/docs/api/wifi/index.rst b/docs/api/wifi/index.rst new file mode 100644 index 000000000..2abe2b2ff --- /dev/null +++ b/docs/api/wifi/index.rst @@ -0,0 +1,8 @@ +Wi-Fi API +********* + +.. toctree:: + :maxdepth: 1 + + Wi-Fi + Smart Config diff --git a/docs/index.rst b/docs/index.rst index eafe10244..d1072b651 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -26,118 +26,46 @@ Contents: .. toctree:: :caption: What Else? :maxdepth: 1 - - General Notes - partition-tables - build_system - openocd - core_dump - Flash encryption - Secure Boot - ULP coprocessor -.. 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 - 1.4. Lower Power Coprocessor - TBA - 1.5. Watchdogs - 1.6. Memory allocation - 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 - - 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 - .. + General Notes + Build System + Debugging + ESP32 Core Dump + Partition Tables + Flash Encryption + Secure Boot + Deep Sleep Wake Stubs + ULP Coprocessor .. toctree:: :caption: API Reference - :maxdepth: 1 + :maxdepth: 2 - Wi-Fi - Smart Config - Bluetooth - Watchdogs - OTA - GPIO - UART - LED Control - Remote Control - Timer - I2C - Pulse Counter - Sigma-delta Modulation - SD/MMC - SPI Flash and Partition APIs - SPI Master API - Logging - Non-Volatile Storage - Virtual Filesystem - FAT Filesystem - Ethernet - Interrupt Allocation - Memory Allocation - Deep Sleep - deep-sleep-stub - - mDNS - Template + Wi-Fi + Bluetooth + Ethernet + Peripherals + System + Storage + Protocols .. toctree:: - :caption: Technical Reference + :caption: Hardware Reference - Technical Reference - -.. Resources - TBA + Technical Reference Manual + Pin List and Functions + Chip Pinout + Silicon Errata .. toctree:: :caption: Contribute :maxdepth: 1 - contributing + Contributions Guide Style Guide - documenting-code - contributor-agreement + Documenting Code + API Template + Contributor Agreement .. toctree:: :caption: Legal @@ -147,8 +75,7 @@ Contents: Indices -------- +======= * :ref:`genindex` -* :ref:`search` diff --git a/docs/api/ulp.rst b/docs/ulp.rst similarity index 100% rename from docs/api/ulp.rst rename to docs/ulp.rst