b9f4822dcb
docs(esp_eth): added warning to not use ESP32 as ETH CLK source with WiFi Closes DOC-8459 See merge request espressif/esp-idf!32736 |
||
|---|---|---|
| .. | ||
| _static | ||
| docs_not_updated | ||
| doxygen | ||
| en | ||
| zh_CN | ||
| check_lang_folder_sync.sh | ||
| component_info_ignore_file.txt | ||
| conf_common.py | ||
| doxygen-known-warnings.txt | ||
| page_redirects.txt | ||
| README.md | ||
| 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/
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