Crash_Override/OVMS3-idf
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

docs: Alphbetically sort toctree

Browse source 
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.
This commit is contained in:
Darian Leung 2019-08-13 16:01:50 +08:00
parent 80a4a11808
commit 75adefe437
9 changed files with 119 additions and 119 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

62
docs/en/api-guides/index.rst
View file

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

12
docs/en/api-reference/bluetooth/index.rst
View file

@ -4,13 +4,13 @@ Bluetooth API
:link_to_translation:`zh_CN:[中文]` :link_to_translation:`zh_CN:[中文]`
.. toctree:: .. toctree::
:maxdepth: 2 :maxdepth: 2
Bluetooth Controller && VHCI <controller_vhci> Bluetooth Controller && VHCI <controller_vhci>
Bluetooth Common <bt_common> Bluetooth Common <bt_common>
Bluetooth LE <bt_le> Bluetooth LE <bt_le>
Bluetooth Classic <classic_bt> Bluetooth Classic <classic_bt>
NimBLE <nimble/index> 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: 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. * For usecases involving classic Bluetooth as well as BLE, Bluedroid should be used.

20
docs/en/api-reference/index.rst
View file

@ -4,15 +4,15 @@ API Reference
:link_to_translation:`zh_CN:[中文]` :link_to_translation:`zh_CN:[中文]`
.. toctree:: .. toctree::
:maxdepth: 2 :maxdepth: 2
Bluetooth <bluetooth/index> Bluetooth <bluetooth/index>
Networking <network/index> Networking <network/index>
Peripherals <peripherals/index> Peripherals <peripherals/index>
Protocols <protocols/index> Protocols <protocols/index>
Provisioning <provisioning/index> Provisioning <provisioning/index>
Storage <storage/index> Storage <storage/index>
System <system/index> System <system/index>
Configuration Options <kconfig> Configuration Options <kconfig>
Error Codes Reference <error-codes> Error Codes Reference <error-codes>

10
docs/en/api-reference/network/index.rst
View file

@ -7,12 +7,12 @@ Wi-Fi
===== =====
.. toctree:: .. toctree::
:maxdepth: 1 :maxdepth: 1
Wi-Fi <esp_wifi> Wi-Fi <esp_wifi>
Smart Config <esp_smartconfig> Smart Config <esp_smartconfig>
ESP-NOW <esp_now> ESP-NOW <esp_now>
ESP Mesh <esp_mesh> ESP Mesh <esp_mesh>
Code examples for the Wi-Fi API are provided in the :example:`wifi` directory of ESP-IDF examples. Code examples for the Wi-Fi API are provided in the :example:`wifi` directory of ESP-IDF examples.

40
docs/en/api-reference/peripherals/index.rst
View file

@ -4,26 +4,26 @@ Peripherals API
:link_to_translation:`zh_CN:[中文]` :link_to_translation:`zh_CN:[中文]`
.. toctree:: .. toctree::
:maxdepth: 1 :maxdepth: 1
ADC <adc> ADC <adc>
CAN <can> CAN <can>
DAC <dac> DAC <dac>
GPIO (including RTC low power I/O) <gpio> GPIO (including RTC low power I/O) <gpio>
I2C <i2c> I2C <i2c>
I2S <i2s> I2S <i2s>
LED Control <ledc> LED Control <ledc>
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>
Timer <timer> Timer <timer>
Touch Sensor <touch_pad> Touch Sensor <touch_pad>
UART <uart> UART <uart>
Code examples for this API section are provided in the :example:`peripherals` directory of ESP-IDF examples. Code examples for this API section are provided in the :example:`peripherals` directory of ESP-IDF examples.

22
docs/en/api-reference/protocols/index.rst
View file

@ -3,18 +3,18 @@ Application Protocols
:link_to_translation:`zh_CN:[中文]` :link_to_translation:`zh_CN:[中文]`
.. toctree:: .. toctree::
:maxdepth: 1 :maxdepth: 1
mDNS <mdns> ASIO <asio>
ESP-TLS <esp_tls> ESP-MQTT <mqtt>
HTTP Client <esp_http_client> ESP-TLS <esp_tls>
Websocket Client <esp_websocket_client> HTTP Client <esp_http_client>
HTTP Server <esp_http_server> HTTP Server <esp_http_server>
HTTPS Server <esp_https_server> HTTPS Server <esp_https_server>
ASIO <asio> Local Control <esp_local_ctrl>
ESP-MQTT <mqtt> mDNS <mdns>
Modbus <modbus> Modbus <modbus>
Local Control <esp_local_ctrl> 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.

8
docs/en/api-reference/provisioning/index.rst
View file

@ -4,10 +4,10 @@ Provisioning API
:link_to_translation:`zh_CN:[中文]` :link_to_translation:`zh_CN:[中文]`
.. 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.

20
docs/en/api-reference/storage/index.rst
View file

@ -2,17 +2,17 @@ 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> Virtual Filesystem <vfs>
Mass Manufacturing Utility <mass_mfg.rst> 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.

44
docs/en/api-reference/system/index.rst
View file

@ -2,29 +2,29 @@ System API
********** **********
.. toctree:: .. toctree::
:maxdepth: 1 :maxdepth: 1
FreeRTOS <freertos> App image format <app_image_format>
FreeRTOS Additions <freertos_additions> Application Level Tracing <app_trace>
Heap Memory Allocation <mem_alloc> eFuse Manager <efuse>
Heap Memory Debugging <heap_debug> Error Codes and Helper Functions <esp_err>
Himem (large external SPI RAM) API <himem> ESP HTTPS OTA <esp_https_ota>
Interrupt Allocation <intr_alloc> ESP pthread <esp_pthread>
Watchdogs <wdts> Event Loop Library <esp_event>
eFuse Manager <efuse> FreeRTOS <freertos>
Inter-Processor Call <ipc> FreeRTOS Additions <freertos_additions>
High Resolution Timer <esp_timer> Heap Memory Allocation <mem_alloc>
Logging <log> Heap Memory Debugging <heap_debug>
Event Loop Library <esp_event> High Resolution Timer <esp_timer>
Application Level Tracing <app_trace> Himem (large external SPI RAM) API <himem>
Power Management <power_management> Inter-Processor Call <ipc>
Sleep Modes <sleep_modes> Interrupt Allocation <intr_alloc>
Over The Air Updates (OTA) <ota> Logging <log>
ESP HTTPS OTA <esp_https_ota> Miscellaneous System APIs <system>
ESP pthread <esp_pthread> Over The Air Updates (OTA) <ota>
Error Codes and Helper Functions <esp_err> Power Management <power_management>
App image format <app_image_format> Sleep Modes <sleep_modes>
Miscellaneous System APIs <system> Watchdogs <wdts>
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.