esp-idf/docs
Wan Lei 32923f8287 Merge branch 'feat/c61_sdspi_support' into 'master'
feat(driver_sdspi): c61 sdspi support

Closes IDF-9305

See merge request espressif/esp-idf!34144
2024-10-25 17:04:22 +08:00
..
_static Merge branch 'docs/delete_user_guide_esp32_s2_and_s3' into 'master' 2024-10-21 16:12:35 +08:00
docs_not_updated Merge branch 'feat/c61_sdspi_support' into 'master' 2024-10-25 17:04:22 +08:00
doxygen fix(wifi): add esp_wifi_types_native.h and esp_wifi_types_generic.h to Doxyfile 2024-10-23 17:10:09 +08:00
en Merge branch 'fix/fix_gpio_config_option' into 'master' 2024-10-25 13:42:49 +08:00
zh_CN Merge branch 'fix/fix_gpio_config_option' into 'master' 2024-10-25 13:42:49 +08:00
README.md
TEMPLATE_EXAMPLE_README.md
check_lang_folder_sync.sh
component_info_ignore_file.txt
conf_common.py docs: enable qemu doc guide for ESP32-S3 2024-09-27 13:34:00 +05:30
doxygen-known-warnings.txt
page_redirects.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

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