mirror of
https://github.com/espressif/esp-idf.git
synced 2025-12-28 13:53:09 +00:00
01b3ffa8e3
This was quite obviously a bad suggestion, and it seems that some users have actually read the docs attentively enough to have followed it. Replace be recommendation to create an alias. Closes https://github.com/espressif/esp-idf/issues/3889
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/
The above URLs are all for the master branch latest version. Click the drop-down in the bottom left to choose a stable version or to download a PDF.
Building Documentation
The documentation build requirements Python 3 and running the wrapper ./build_docs.py tool. Running ./build_docs.py --help will give a summary of available options.
See Documenting Code in the ESP-IDF Programming Guide for full information about setting up to build the docs, and how to use the ./build_docs.py tool.