Files
esp-idf/docs
Guillaume Souchere 177024eeeb fix(heap): Do not consider newly registered heap in minimum free size calcualtion
After startup is done and app_main is reached, all calls to
heap_caps_add_region_with_caps (adding a new heap to the list of registered
heaps) will not affect the minimum free heap size value.

For heaps created before startup, this won't apply and their size will
end up being taken into account in the calculation of the minimum.
2026-05-28 10:30:25 +02:00
..
2026-04-16 17:28:19 +08:00

Documentation Source Folder

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

The sources do not render well in GitHub and some information is not visible without building the documentation.

Use the actual documentation, which is generated within about 20 minutes of each commit:

Hosted Documentation

After clicking 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 at the bottom right to download the HTML version as a zip for offline reading.

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