esp-idf/docs/en/api-guides/index.rst

API Guides
**********
:link_to_translation:`zh_CN:[中文]`

.. toctree::
   :maxdepth: 1

   app_trace
   startup
   :SOC_BLUFI_SUPPORTED: blufi
   bootloader
   build-system
   :SOC_SUPPORT_COEXISTENCE: coexist
   core_dump
   cplusplus
   current-consumption-measurement-modules
   :SOC_RTC_MEM_SUPPORTED: deep-sleep-stub
   :SOC_USB_OTG_SUPPORTED: dfu
   error-handling
   :SOC_BLE_MESH_SUPPORTED: esp-ble-mesh/ble-mesh-index
   :SOC_WIFI_MESH_SUPPORT: esp-wifi-mesh
   :SOC_SPIRAM_SUPPORTED: external-ram
   ../security/host-based-security-workflows
   fatal-errors
   ../security/flash-encryption
   :esp32s3: flash_psram_config
   hardware-abstraction
   :CONFIG_IDF_TARGET_ARCH_XTENSA: hlinterrupts
   jtag-debugging/index
   linker-script-generation
   lwip
   memory-types
   openthread
   partition-tables
   performance/index
   reproducible-builds
   :not esp32h2: RF_calibration
   ../security/security
   :esp32: ../security/secure-boot-v1
   ../security/secure-boot-v2
   thread-local-storage
   tools/index
   unit-tests
   host-apps
   :SOC_USB_OTG_SUPPORTED: usb-otg-console
   :SOC_USB_SERIAL_JTAG_SUPPORTED: usb-serial-jtag-console
   :SOC_WIFI_SUPPORTED: wifi
   :SOC_WIFI_SUPPORTED: wifi-security
Getting started guides 2017-03-26 18:01:52 -04:00			`API Guides`
			`**********`
Included missing links between English and Chinese documentation, where translation into Chinese is available 2019-01-27 13:01:34 -05:00			:link_to_translation:`zh_CN:[中文]`
Getting started guides 2017-03-26 18:01:52 -04:00
			`.. toctree::`
docs: Updated CN translation for index files in api-guides and api-reference 2021-12-30 05:50:55 -05:00			`:maxdepth: 1`
Getting started guides 2017-03-26 18:01:52 -04:00
docs: Updated CN translation for index files in api-guides and api-reference 2021-12-30 05:50:55 -05:00			`app_trace`
			`startup`
ble docs: Update the ble docs for esp32c6 and esp32h2 2023-05-17 05:36:15 -04:00			`:SOC_BLUFI_SUPPORTED: blufi`
docs: Updated CN translation for index files in api-guides and api-reference 2021-12-30 05:50:55 -05:00			`bootloader`
			`build-system`
docs: add C++ support chapter to the API guides 2022-09-15 12:05:32 -04:00			`:SOC_SUPPORT_COEXISTENCE: coexist`
docs: Updated CN translation for index files in api-guides and api-reference 2021-12-30 05:50:55 -05:00			`core_dump`
docs: add C++ support chapter to the API guides 2022-09-15 12:05:32 -04:00			`cplusplus`
docs: add a chapter to describe how to measure current of modules in deep sleep mode 2022-12-05 05:25:19 -05:00			`current-consumption-measurement-modules`
docs: update system API-guides for ESP32-C2 2022-07-11 05:11:27 -04:00			`:SOC_RTC_MEM_SUPPORTED: deep-sleep-stub`
docs: Updated CN translation for index files in api-guides and api-reference 2021-12-30 05:50:55 -05:00			`:SOC_USB_OTG_SUPPORTED: dfu`
			`error-handling`
ble_mesh: docs: Remove BLE Mesh related reference for C2 2022-08-11 05:21:27 -04:00			`:SOC_BLE_MESH_SUPPORTED: esp-ble-mesh/ble-mesh-index`
doc: esp32c2 wifi programming guide doc. 2022-07-07 02:13:11 -04:00			`:SOC_WIFI_MESH_SUPPORT: esp-wifi-mesh`
docs: add C++ support chapter to the API guides 2022-09-15 12:05:32 -04:00			`:SOC_SPIRAM_SUPPORTED: external-ram`
docs: Added documentation about enabling the Security Features externally with help of espefuse tool flash_encryption_doc: Fix the document to also inform users about what happens in case of host generated private key in the Flash encryption process 2023-04-15 06:38:57 -04:00			`../security/host-based-security-workflows`
docs: Updated CN translation for index files in api-guides and api-reference 2021-12-30 05:50:55 -05:00			`fatal-errors`
			`../security/flash-encryption`
docs: translate coexist from CN to EN 2021-07-28 23:20:52 -04:00			`:esp32s3: flash_psram_config`
docs: Updated CN translation for index files in api-guides and api-reference 2021-12-30 05:50:55 -05:00			`hardware-abstraction`
			`:CONFIG_IDF_TARGET_ARCH_XTENSA: hlinterrupts`
			`jtag-debugging/index`
			`linker-script-generation`
			`lwip`
			`memory-types`
			`openthread`
			`partition-tables`
			`performance/index`
docs: add C++ support chapter to the API guides 2022-09-15 12:05:32 -04:00			`reproducible-builds`
docs: add support for building H2 docs 2023-01-06 02:25:58 -05:00			`:not esp32h2: RF_calibration`
docs: add chapter about overall "security" area guide List down considerations for the following areas: - Hardware security - Network security - Product security Also added brief explanation about "Security Policy" for ESP-IDF. Closes IDF-1565 2022-11-18 03:33:10 -05:00			`../security/security`
docs: Updated CN translation for index files in api-guides and api-reference 2021-12-30 05:50:55 -05:00			`:esp32: ../security/secure-boot-v1`
			`../security/secure-boot-v2`
			`thread-local-storage`
			`tools/index`
			`unit-tests`
docs(linux): refactored and updated Linux target docs 2022-11-22 11:13:21 -05:00			`host-apps`
docs: Updated CN translation for index files in api-guides and api-reference 2021-12-30 05:50:55 -05:00			`:SOC_USB_OTG_SUPPORTED: usb-otg-console`
			`:SOC_USB_SERIAL_JTAG_SUPPORTED: usb-serial-jtag-console`
			`:SOC_WIFI_SUPPORTED: wifi`
docs: Updated ULP documentation This commit updates documentation for ULP. 2022-02-21 05:43:02 -05:00			`:SOC_WIFI_SUPPORTED: wifi-security`