kopia lustrzana https://github.com/espressif/esp-idf
070eaea67e
Add documentation to avoid using WiFi modem sleep for WiFi/BT coexistence Remove description of unusable API esp_wifi_restart() Update esp_now_fetch_peer discription Update table format prblm for esp_wifi_set_max_tx_power() Update description for ssid and password Closes https://github.com/espressif/esp-idf/issues/6049 Closes https://github.com/espressif/esp-idf/issues/5759 Closes https://github.com/espressif/esp-idf/issues/5719 Closes https://github.com/espressif/esp-idf/issues/3762 |
||
|---|---|---|
| .. | ||
| _static | ||
| en | ||
| extensions | ||
| idf_extensions | ||
| latex_templates | ||
| test | ||
| zh_CN | ||
| Doxyfile | ||
| README.md | ||
| TEMPLATE_EXAMPLE_README.md | ||
| build_docs.py | ||
| check_lang_folder_sync.sh | ||
| conf_common.py | ||
| doxygen-known-warnings.txt | ||
| generate_chart.py | ||
| get_github_rev.py | ||
| page_redirects.txt | ||
| requirements.txt | ||
| sanitize_version.py | ||
| 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
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.