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.
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
- English: https://docs.espressif.com/projects/esp-idf/en/latest/
- 中文: https://docs.espressif.com/projects/esp-idf/zh_CN/latest/
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