esp-idf/docs
Guillaume Souchere d98b0c497a docs(performance): Add esp32p4/c5 relevant information to the performance guides
in speed.rst:
- add startup time increase info when spiram test is enabled
- add startup time increase info when spiram is enabled and
  poisoning comprehensive is enabled
- add L2 cache variable size info to optimize IRAM space / cache misses
- update sections refencing bluetooth/wifi built-in tasks to not show
  related info for p4 targets.
- Add IDF_TARGET_RF_TYPE for esp32c5

in ram-usage.rst:
- add L2 cache variable size info to maximize RAM space

Remove the files from esp32c5.txt and esp32p4.txt
that are no longer in need of update.
2024-05-20 09:40:05 +02:00
..
_static Docs: Added missing USB functions to ESP32-C3 DevKit User Guides 2024-05-15 19:06:26 +08:00
docs_not_updated docs(performance): Add esp32p4/c5 relevant information to the performance guides 2024-05-20 09:40:05 +02:00
doxygen feat(esp_eth): a new folder structure of the driver and other improvements 2024-05-14 08:23:31 +02:00
en docs(performance): Add esp32p4/c5 relevant information to the performance guides 2024-05-20 09:40:05 +02:00
zh_CN Merge branch 'docs/translate_four_docs_in_api-guides' into 'master' 2024-05-16 15:57:50 +08:00
check_lang_folder_sync.sh global: use '/usr/bin/env bash' instead of '/usr/bin/bash' in shebangs 2020-04-03 01:10:02 +02:00
component_info_ignore_file.txt feat(ulp): support interrupts for C6/P4 LP core 2024-04-28 17:03:23 +08:00
conf_common.py docs(usb): Add USBH maintainer notes 2024-04-23 17:18:56 +08:00
doxygen-known-warnings.txt change(freertos/idf): Update FreeRTOS documentation build 2023-10-21 04:39:17 +08:00
page_redirects.txt doc: remove left-over legacy event loop docs 2023-03-17 15:37:26 +08:00
README.md docs: Update example README template and other related docs 2024-04-15 17:17:27 +08:00
sphinx-known-warnings.txt fix(ble_mesh): Miscellaneous update for ble mesh 2023-09-16 15:58:14 +08:00
TEMPLATE_EXAMPLE_README.md docs: Update alerts in READMEs to GFM format 2024-05-06 15:19:15 +08:00

Documentation Source Folder

This folder contains source files of ESP-IDF documentation available in English and 中文.

The sources do not render well in GitHub and some information is not visible at all.

Use actual documentation generated within about 20 minutes on each commit:

Hosted Documentation

After you click any link to ESP-IDF Programming Guide, go to the top of the sidebar, then make sure you have the correct Espressif chip (target) and ESP-IDF version selected in the dropdown menus. You can also find a link on the bottom right to download the PDF version.

Building Documentation

The documentation is built using the python package esp-docs, which can be installed by running:

pip install esp-docs

For a summary of available options, run:

build-docs --help

For more information see the esp-docs documentation at https://github.com/espressif/esp-docs/blob/master/README.md