kopia lustrzana https://github.com/espressif/esp-idf
dfc95bc78b
Closes IDF-1371 Added an include directive that allows for the content to be formatted according to idf target |
||
|---|---|---|
| .. | ||
| _static | ||
| en | ||
| extensions | ||
| idf_extensions | ||
| zh_CN | ||
| Doxyfile | ||
| README.md | ||
| TEMPLATE_EXAMPLE_README.md | ||
| build_docs.py | ||
| check_lang_folder_sync.sh | ||
| conf_common.py | ||
| doxygen-known-warnings.txt | ||
| page_redirects.txt | ||
| requirements.txt | ||
| sphinx-known-warnings.txt | ||
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
- Documentation build requres Python 3 and will not work with Python 2
- Install dependencies for ESP-IDF as per the Getting Started guide
- Install documentation Python depdendencies, ie
pip install -r $IDF_PATH/docs/requirements.txt - Run
./build_docs.py buildto build docs for all supported Language & Target combinations, or./build_docs.py -t esp32 -l en buildto build docs for a single supported language & target combination only.
See Documenting Code for more information.
Available languages are en and zh_CN, targets are any target supported by ESP-IDF - for example esp32 or esp32s2.