Merge branch 'docs/order_toctree_alphabetically' into 'master'

docs: Alphbetically sort toctree

See merge request espressif/esp-idf!5770
This commit is contained in:
Angus Gratton
2019-08-15 12:41:54 +08:00
9 changed files with 119 additions and 119 deletions

View File

@@ -5,33 +5,33 @@ API Guides
.. toctree:: .. toctree::
:maxdepth: 1 :maxdepth: 1
General Notes <general-notes> Application Level Tracing <app_trace>
BluFi <blufi>
Bootloader <bootloader>
Build System <build-system> Build System <build-system>
Build System (Legacy GNU Make) <build-system-legacy> Build System (Legacy GNU Make) <build-system-legacy>
Error Handling <error-handling> Console Component <console>
Fatal Errors <fatal-errors>
Event Handling <event-handling>
Deep Sleep Wake Stubs <deep-sleep-stub> Deep Sleep Wake Stubs <deep-sleep-stub>
Error Handling <error-handling>
ESP-MESH <mesh>
ESP32 Core Dump <core_dump> ESP32 Core Dump <core_dump>
Event Handling <event-handling>
External SPI-connected RAM <external-ram>
Fatal Errors <fatal-errors>
Flash Encryption <../security/flash-encryption> Flash Encryption <../security/flash-encryption>
FreeRTOS SMP Changes <freertos-smp> FreeRTOS SMP Changes <freertos-smp>
Thread Local Storage <thread-local-storage> General Notes <general-notes>
High Level Interrupts <hlinterrupts> High Level Interrupts <hlinterrupts>
JTAG Debugging <jtag-debugging/index> 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> 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> 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>

View File

@@ -16,9 +16,9 @@ Peripherals API
MCPWM <mcpwm> MCPWM <mcpwm>
Pulse Counter <pcnt> Pulse Counter <pcnt>
Remote Control <rmt> Remote Control <rmt>
SDMMC Host <sdmmc_host>
SD SPI Host <sdspi_host> SD SPI Host <sdspi_host>
SDIO Slave <sdio_slave> SDIO Slave <sdio_slave>
SDMMC Host <sdmmc_host>
Sigma-delta Modulation <sigmadelta> Sigma-delta Modulation <sigmadelta>
SPI Master <spi_master> SPI Master <spi_master>
SPI Slave <spi_slave> SPI Slave <spi_slave>

View File

@@ -5,16 +5,16 @@ Application Protocols
.. toctree:: .. 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> ASIO <asio>
ESP-MQTT <mqtt> ESP-MQTT <mqtt>
Modbus <modbus> ESP-TLS <esp_tls>
HTTP Client <esp_http_client>
HTTP Server <esp_http_server>
HTTPS Server <esp_https_server>
Local Control <esp_local_ctrl> 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. Code examples for this API section are provided in the :example:`protocols` directory of ESP-IDF examples.

View File

@@ -6,8 +6,8 @@ Provisioning API
.. toctree:: .. toctree::
:maxdepth: 1 :maxdepth: 1
Unified Provisioning <provisioning>
Protocol Communication <protocomm> Protocol Communication <protocomm>
Unified Provisioning <provisioning>
Wi-Fi Provisioning <wifi_provisioning> Wi-Fi Provisioning <wifi_provisioning>
Code examples for this API section are provided in the :example:`provisioning` directory of ESP-IDF examples. Code examples for this API section are provided in the :example:`provisioning` directory of ESP-IDF examples.

View File

@@ -4,15 +4,15 @@ Storage API
.. toctree:: .. toctree::
:maxdepth: 1 :maxdepth: 1
SPI Flash and Partition APIs <spi_flash> FAT Filesystem <fatfs>
SD/SDIO/MMC Driver <sdmmc> Mass Manufacturing Utility <mass_mfg.rst>
Non-Volatile Storage <nvs_flash> Non-Volatile Storage <nvs_flash>
NVS Partition Generation Utility <nvs_partition_gen.rst> NVS Partition Generation Utility <nvs_partition_gen.rst>
Virtual Filesystem <vfs> SD/SDIO/MMC Driver <sdmmc>
FAT Filesystem <fatfs> SPI Flash and Partition APIs <spi_flash>
Wear Levelling <wear-levelling>
SPIFFS Filesystem <spiffs> SPIFFS Filesystem <spiffs>
Mass Manufacturing Utility <mass_mfg.rst> Virtual Filesystem <vfs>
Wear Levelling <wear-levelling>
Code examples for this API section are provided in the :example:`storage` directory of ESP-IDF examples. Code examples for this API section are provided in the :example:`storage` directory of ESP-IDF examples.

View File

@@ -4,27 +4,27 @@ System API
.. toctree:: .. toctree::
:maxdepth: 1 :maxdepth: 1
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 <freertos>
FreeRTOS Additions <freertos_additions> FreeRTOS Additions <freertos_additions>
Heap Memory Allocation <mem_alloc> Heap Memory Allocation <mem_alloc>
Heap Memory Debugging <heap_debug> 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> High Resolution Timer <esp_timer>
Himem (large external SPI RAM) API <himem>
Inter-Processor Call <ipc>
Interrupt Allocation <intr_alloc>
Logging <log> Logging <log>
Event Loop Library <esp_event> Miscellaneous System APIs <system>
Application Level Tracing <app_trace> Over The Air Updates (OTA) <ota>
Power Management <power_management> Power Management <power_management>
Sleep Modes <sleep_modes> Sleep Modes <sleep_modes>
Over The Air Updates (OTA) <ota> Watchdogs <wdts>
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>
Code examples for this API section are provided in the :example:`system` directory of ESP-IDF examples. Code examples for this API section are provided in the :example:`system` directory of ESP-IDF examples.