mirror of
https://github.com/espressif/esp-idf.git
synced 2024-10-05 20:47:46 -04:00
|
|
||
|---|---|---|
| .. | ||
| _static | ||
| en | ||
| extensions | ||
| idf_extensions | ||
| latex_templates | ||
| zh_CN | ||
| build_docs.py | ||
| check_lang_folder_sync.sh | ||
| conf_common.py | ||
| Doxyfile | ||
| doxygen-known-warnings.txt | ||
| page_redirects.txt | ||
| README.md | ||
| requirements.txt | ||
| sanitize_version.py | ||
| sphinx-known-warnings.txt | ||
| TEMPLATE_EXAMPLE_README.md | ||
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.