docs: Alphbetically sort toctree

This commit sorts the entries of variuos toctrees
alphabetically. Indentation was also fixed. The order
of some toctrees were not modified if the existing
order had some form of suggested reading order.

diff --git a/docs/en/api-guides/index.rst b/docs/en/api-guides/index.rst
index cc762d3b33fcba52df421fad71a9136b48b797d9..fdfd58c984751940208a6a94925affc5659e0dfb 100644 (file)
--- a/docs/en/api-guides/index.rst
+++ b/docs/en/api-guides/index.rst
@@ -3,35 +3,35 @@ API Guides
 :link_to_translation:`zh_CN:[中文]`
 
 .. toctree::
-   :maxdepth: 1
+    :maxdepth: 1
 
-   General Notes <general-notes>
-   Build System <build-system>
-   Build System (Legacy GNU Make) <build-system-legacy>
-   Error Handling <error-handling>
-   Fatal Errors <fatal-errors>
-   Event Handling <event-handling>
-   Deep Sleep Wake Stubs <deep-sleep-stub>
-   ESP32 Core Dump <core_dump>
-   Flash Encryption <../security/flash-encryption>
-   FreeRTOS SMP Changes <freertos-smp>
-   Thread Local Storage <thread-local-storage>
-   High Level Interrupts <hlinterrupts>
-   JTAG Debugging <jtag-debugging/index>
-   Bootloader <bootloader>
-   Partition Tables <partition-tables>
-   Secure Boot <../security/secure-boot>
-   ULP Coprocessor <ulp>
-   ULP Coprocessor (Legacy GNU Make) <ulp-legacy>
-   Unit Testing <unit-tests>
-   Unit Testing (Legacy GNU Make) <unit-tests-legacy>
-   Application Level Tracing <app_trace>
-   Console Component <console>
-   ROM debug console <romconsole>
-   RF Calibration <RF_calibration>
-   WiFi Driver <wifi>
-   ESP-MESH <mesh>
-   BluFi <blufi>
-   External SPI-connected RAM <external-ram>
-   Linker Script Generation <linker-script-generation>
-   Tools <tools/index>
+    Application Level Tracing <app_trace>
+    BluFi <blufi>
+    Bootloader <bootloader>
+    Build System <build-system>
+    Build System (Legacy GNU Make) <build-system-legacy>
+    Console Component <console>
+    Deep Sleep Wake Stubs <deep-sleep-stub>
+    Error Handling <error-handling>
+    ESP-MESH <mesh>
+    ESP32 Core Dump <core_dump>
+    Event Handling <event-handling>
+    External SPI-connected RAM <external-ram>
+    Fatal Errors <fatal-errors>
+    Flash Encryption <../security/flash-encryption>
+    FreeRTOS SMP Changes <freertos-smp>
+    General Notes <general-notes>
+    High Level Interrupts <hlinterrupts>
+    JTAG Debugging <jtag-debugging/index>
+    Linker Script Generation <linker-script-generation>
+    Partition Tables <partition-tables>
+    RF Calibration <RF_calibration>
+    ROM debug console <romconsole>
+    Secure Boot <../security/secure-boot>
+    Thread Local Storage <thread-local-storage>
+    Tools <tools/index>
+    ULP Coprocessor (Legacy GNU Make) <ulp-legacy>
+    ULP Coprocessor <ulp>
+    Unit Testing (Legacy GNU Make) <unit-tests-legacy>
+    Unit Testing <unit-tests>
+    WiFi Driver <wifi>

diff --git a/docs/en/api-reference/bluetooth/index.rst b/docs/en/api-reference/bluetooth/index.rst
index da9f19d65cc6982388601f739f29d0cc40fbb249..d2500835861d4347a08ebfb881eb7dbd5401fc17 100644 (file)
--- a/docs/en/api-reference/bluetooth/index.rst
+++ b/docs/en/api-reference/bluetooth/index.rst
@@ -4,13 +4,13 @@ Bluetooth API
 :link_to_translation:`zh_CN:[中文]`
 
 .. toctree::
-   :maxdepth: 2
+    :maxdepth: 2
 
-   Bluetooth Controller && VHCI <controller_vhci>
-   Bluetooth Common <bt_common>
-   Bluetooth LE <bt_le>
-   Bluetooth Classic <classic_bt>
-   NimBLE <nimble/index>
+    Bluetooth Controller && VHCI <controller_vhci>
+    Bluetooth Common <bt_common>
+    Bluetooth LE <bt_le>
+    Bluetooth Classic <classic_bt>
+    NimBLE <nimble/index>
 
 ESP-IDF currently supports two host stacks. The Bluedroid based stack (default) supports classic Bluetooth as well as BLE. On the other hand, Apache NimBLE based stack is BLE only. For users to make a choice:
 * For usecases involving classic Bluetooth as well as BLE, Bluedroid should be used.

diff --git a/docs/en/api-reference/index.rst b/docs/en/api-reference/index.rst
index a083fe82a2147ee2d8dcd5fec6c60ce09e71bc2b..92e57f8cc8e787e21c061f13a3c9bcd04951b27d 100644 (file)
--- a/docs/en/api-reference/index.rst
+++ b/docs/en/api-reference/index.rst
@@ -4,15 +4,15 @@ API Reference
 :link_to_translation:`zh_CN:[中文]`
 
 .. toctree::
-   :maxdepth: 2
+    :maxdepth: 2
 
-   Bluetooth <bluetooth/index>
-   Networking <network/index>
-   Peripherals <peripherals/index>
-   Protocols <protocols/index>
-   Provisioning <provisioning/index>
-   Storage <storage/index>
-   System <system/index>
-   Configuration Options <kconfig>
-   Error Codes Reference <error-codes>
+    Bluetooth <bluetooth/index>
+    Networking <network/index>
+    Peripherals <peripherals/index>
+    Protocols <protocols/index>
+    Provisioning <provisioning/index>
+    Storage <storage/index>
+    System <system/index>
+    Configuration Options <kconfig>
+    Error Codes Reference <error-codes>
 

diff --git a/docs/en/api-reference/network/index.rst b/docs/en/api-reference/network/index.rst
index f555a456c030566c8d92119f4f706436d0fdd5b4..cb5c5801b39ed420f8d589c4951ea7f537f579fc 100644 (file)
--- a/docs/en/api-reference/network/index.rst
+++ b/docs/en/api-reference/network/index.rst
@@ -7,12 +7,12 @@ Wi-Fi
 =====
 
 .. toctree::
-   :maxdepth: 1
+    :maxdepth: 1
 
-   Wi-Fi <esp_wifi>
-   Smart Config <esp_smartconfig>
-   ESP-NOW <esp_now>
-   ESP Mesh <esp_mesh>
+    Wi-Fi <esp_wifi>
+    Smart Config <esp_smartconfig>
+    ESP-NOW <esp_now>
+    ESP Mesh <esp_mesh>
 
 Code examples for the Wi-Fi API are provided in the :example:`wifi` directory of ESP-IDF examples.
 

diff --git a/docs/en/api-reference/peripherals/index.rst b/docs/en/api-reference/peripherals/index.rst
index b9b85c203332f437d3243731df8c2cd717166a87..73c5b42edf78c8e4c5c4fdb4e838df1026def724 100644 (file)
--- a/docs/en/api-reference/peripherals/index.rst
+++ b/docs/en/api-reference/peripherals/index.rst
@@ -4,26 +4,26 @@ Peripherals API
 :link_to_translation:`zh_CN:[中文]`
 
 .. toctree::
-   :maxdepth: 1
+    :maxdepth: 1
 
-   ADC <adc>
-   CAN <can>
-   DAC <dac>
-   GPIO (including RTC low power I/O) <gpio>
-   I2C <i2c>
-   I2S <i2s>
-   LED Control <ledc>
-   MCPWM <mcpwm>
-   Pulse Counter <pcnt>
-   Remote Control <rmt>
-   SDMMC Host <sdmmc_host>
-   SD SPI Host <sdspi_host>
-   SDIO Slave <sdio_slave>
-   Sigma-delta Modulation <sigmadelta>
-   SPI Master <spi_master>
-   SPI Slave <spi_slave>
-   Timer <timer>
-   Touch Sensor <touch_pad>
-   UART <uart>
+    ADC <adc>
+    CAN <can>
+    DAC <dac>
+    GPIO (including RTC low power I/O) <gpio>
+    I2C <i2c>
+    I2S <i2s>
+    LED Control <ledc>
+    MCPWM <mcpwm>
+    Pulse Counter <pcnt>
+    Remote Control <rmt>
+    SD SPI Host <sdspi_host>
+    SDIO Slave <sdio_slave>
+    SDMMC Host <sdmmc_host>
+    Sigma-delta Modulation <sigmadelta>
+    SPI Master <spi_master>
+    SPI Slave <spi_slave>
+    Timer <timer>
+    Touch Sensor <touch_pad>
+    UART <uart>
 
 Code examples for this API section are provided in the :example:`peripherals` directory of ESP-IDF examples.

diff --git a/docs/en/api-reference/protocols/index.rst b/docs/en/api-reference/protocols/index.rst
index c35c954f353a1c93c4e62ad84a14cb13ff802d3a..36af219894b75b9d7c25a72bcc1c1cb140b6065b 100644 (file)
--- a/docs/en/api-reference/protocols/index.rst
+++ b/docs/en/api-reference/protocols/index.rst
@@ -3,18 +3,18 @@ Application Protocols
 :link_to_translation:`zh_CN:[中文]`
 
 .. toctree::
-   :maxdepth: 1
+    :maxdepth: 1
 
-   mDNS <mdns>
-   ESP-TLS <esp_tls>
-   HTTP Client <esp_http_client>
-   Websocket Client <esp_websocket_client>
-   HTTP Server <esp_http_server>
-   HTTPS Server <esp_https_server>
-   ASIO <asio>
-   ESP-MQTT <mqtt>
-   Modbus <modbus>
-   Local Control <esp_local_ctrl>
+    ASIO <asio>
+    ESP-MQTT <mqtt>
+    ESP-TLS <esp_tls>
+    HTTP Client <esp_http_client>
+    HTTP Server <esp_http_server>
+    HTTPS Server <esp_https_server>
+    Local Control <esp_local_ctrl>
+    mDNS <mdns>
+    Modbus <modbus>
+    Websocket Client <esp_websocket_client>
 
 Code examples for this API section are provided in the :example:`protocols` directory of ESP-IDF examples.
 

diff --git a/docs/en/api-reference/provisioning/index.rst b/docs/en/api-reference/provisioning/index.rst
index 0243ec19f64ff72d9247c254f28b9d5a99c56a1d..c2341ad73aa2ab14b6e8008e7b45f24f00134605 100644 (file)
--- a/docs/en/api-reference/provisioning/index.rst
+++ b/docs/en/api-reference/provisioning/index.rst
@@ -4,10 +4,10 @@ Provisioning API
 :link_to_translation:`zh_CN:[中文]`
 
 .. toctree::
-   :maxdepth: 1
+    :maxdepth: 1
 
-   Unified Provisioning <provisioning>
-   Protocol Communication <protocomm>
-   Wi-Fi Provisioning <wifi_provisioning>
+    Protocol Communication <protocomm>
+    Unified Provisioning <provisioning>
+    Wi-Fi Provisioning <wifi_provisioning>
 
 Code examples for this API section are provided in the :example:`provisioning` directory of ESP-IDF examples.

diff --git a/docs/en/api-reference/storage/index.rst b/docs/en/api-reference/storage/index.rst
index d80e30b56e8b012b6816d64d46af9496064bb9a7..23cb38b64762aa21b53b40e170f9e01cadf7a48b 100644 (file)
--- a/docs/en/api-reference/storage/index.rst
+++ b/docs/en/api-reference/storage/index.rst
@@ -2,17 +2,17 @@ Storage API
 ***********
 
 .. toctree::
-   :maxdepth: 1
+    :maxdepth: 1
 
-   SPI Flash and Partition APIs <spi_flash>
-   SD/SDIO/MMC Driver <sdmmc>
-   Non-Volatile Storage <nvs_flash>
-   NVS Partition Generation Utility <nvs_partition_gen.rst>
-   Virtual Filesystem <vfs>
-   FAT Filesystem <fatfs>
-   Wear Levelling <wear-levelling>
-   SPIFFS Filesystem <spiffs>
-   Mass Manufacturing Utility <mass_mfg.rst>
+    FAT Filesystem <fatfs>
+    Mass Manufacturing Utility <mass_mfg.rst>
+    Non-Volatile Storage <nvs_flash>
+    NVS Partition Generation Utility <nvs_partition_gen.rst>
+    SD/SDIO/MMC Driver <sdmmc>
+    SPI Flash and Partition APIs <spi_flash>
+    SPIFFS Filesystem <spiffs>
+    Virtual Filesystem <vfs>
+    Wear Levelling <wear-levelling>
 
 
 Code examples for this API section are provided in the :example:`storage` directory of ESP-IDF examples.

diff --git a/docs/en/api-reference/system/index.rst b/docs/en/api-reference/system/index.rst
index 1f2c25940f218e45faaf85a46e0a3ab08cbb1776..8faac3a0b3fa6859c5ca245ecda0cc5e1f0fe638 100644 (file)
--- a/docs/en/api-reference/system/index.rst
+++ b/docs/en/api-reference/system/index.rst
@@ -2,29 +2,29 @@ System API
 **********
 
 .. toctree::
-   :maxdepth: 1
+    :maxdepth: 1
 
-   FreeRTOS <freertos>
-   FreeRTOS Additions <freertos_additions>
-   Heap Memory Allocation <mem_alloc>
-   Heap Memory Debugging <heap_debug>
-   Himem (large external SPI RAM) API <himem>
-   Interrupt Allocation <intr_alloc>
-   Watchdogs <wdts>
-   eFuse Manager <efuse>
-   Inter-Processor Call <ipc>
-   High Resolution Timer <esp_timer>
-   Logging <log>
-   Event Loop Library <esp_event>
-   Application Level Tracing <app_trace>
-   Power Management <power_management>
-   Sleep Modes <sleep_modes>
-   Over The Air Updates (OTA) <ota>
-   ESP HTTPS OTA <esp_https_ota>
-   ESP pthread <esp_pthread>
-   Error Codes and Helper Functions <esp_err>
-   App image format <app_image_format>
-   Miscellaneous System APIs <system>
+    App image format <app_image_format>
+    Application Level Tracing <app_trace>
+    eFuse Manager <efuse>
+    Error Codes and Helper Functions <esp_err>
+    ESP HTTPS OTA <esp_https_ota>
+    ESP pthread <esp_pthread>
+    Event Loop Library <esp_event>
+    FreeRTOS <freertos>
+    FreeRTOS Additions <freertos_additions>
+    Heap Memory Allocation <mem_alloc>
+    Heap Memory Debugging <heap_debug>
+    High Resolution Timer <esp_timer>
+    Himem (large external SPI RAM) API <himem>
+    Inter-Processor Call <ipc>
+    Interrupt Allocation <intr_alloc>
+    Logging <log>
+    Miscellaneous System APIs <system>
+    Over The Air Updates (OTA) <ota>
+    Power Management <power_management>
+    Sleep Modes <sleep_modes>
+    Watchdogs <wdts>
 
 
 Code examples for this API section are provided in the :example:`system` directory of ESP-IDF examples.