esp-idf/docs
Darian cc34c4fc08 Merge branch 'contrib/github_pr_12481' into 'master'
Many places in the ESP_SYSTEM are using CONFIG_FREERTOS_UNICORE instead of CONFIG_ESP_SYSTEM_SINGLE_CORE_MODE (GitHub PR)

Closes IDFGH-11333

See merge request espressif/esp-idf!27435
2023-12-01 19:33:19 +08:00
..
_static doc(sdmmc): doc(sdmmc): updated sdmmc programming guide for esp32p4 2023-11-29 11:13:14 +08:00
docs_not_updated doc(sdmmc): doc(sdmmc): updated sdmmc programming guide for esp32p4 2023-11-29 11:13:14 +08:00
doxygen change(sdm): move driver to a new component: esp_driver_sdm 2023-12-01 10:03:48 +08:00
en Merge branch 'contrib/github_pr_12481' into 'master' 2023-12-01 19:33:19 +08:00
zh_CN Merge branch 'contrib/github_pr_12481' into 'master' 2023-12-01 19:33:19 +08:00
README.md
TEMPLATE_EXAMPLE_README.md
check_lang_folder_sync.sh
component_info_ignore_file.txt
conf_common.py
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

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 is built using the python package esp-docs, which can be installed by running pip install esp-docs. Running build-docs --help will give a summary of available options. For more information see the esp-docs documentation at https://github.com/espressif/esp-docs/blob/master/README.md