b8ded7cb65
Although the current documentation exposes only limited functionality, which is unlikely to change, add an explicit note that the build system v2 is currently a technical preview intended for testing and early evaluation. Ensure consistency in referring to v2 throughout the documentation. In some places, it is referred to as V2 or Version 2; unify this to v2. Additionally, update the hello_world example for v2 to use the idf::spi_flash alias instead of the interface variable to maintain consistency with the rest of the documentation. Signed-off-by: Frantisek Hrbata <frantisek.hrbata@espressif.com>
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