db6b310447
Add a global -j/--jobs option to idf.py that sets the number of parallel build jobs passed to the underlying build tool. Previously parallelism was only configurable via the IDF_PY_BUILD_JOBS environment variable, and only for the Ninja generator. The option applies to both Ninja and Make and defaults to IDF_PY_BUILD_JOBS when not given, so the environment variable keeps working as before. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
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
- English: https://docs.espressif.com/projects/esp-idf/en/latest/
- Chinese: https://docs.espressif.com/projects/esp-idf/zh_CN/latest/
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