Files
esp-idf/docs
Jan Beran 9522af1d8f feat: introduce esp-idf-configdep as a build optimization
The esp-idf-configdep utility works as a compiler wrapper. It lets the
compiler compile the app and checks whether -MF option was used to
generate dependency files. If yes, it checks for sdkconfig.h dependency
in those files.

Target file depending on sdkconfig.h is then scanned for all CONFIG_*
occurrences and the dependency file is altered so that the given target
file is marked as "dirty" only if the config options it actually uses
are changed.

This ensures that after a configuration update, only affected files are
rebuilt, reducing incremental build times.

The compiler launcher mechanism is changed from RULE_LAUNCH_COMPILE
(Makefile-only) to CMAKE_*_COMPILER_LAUNCHER (generator-agnostic),
enabling launcher chaining (configdep -> ccache -> compiler).

Made-with: Cursor
2026-06-02 01:26:10 +08: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