esp-idf/docs
Armando (Dou Yiwen) 7e9b9d5ee8 Merge branch 'change/rename_csi_api' into 'master'
change(camera): change esp_cam_del_ctlr to esp_cam_ctlr_del

See merge request espressif/esp-idf!30516
2024-04-28 11:54:29 +08:00
..
_static docs(jpeg): Add docs for explain pixel order supported in jpeg driver 2024-04-17 19:16:44 +08:00
docs_not_updated docs(usb): Add USBH maintainer notes 2024-04-23 17:18:56 +08:00
doxygen Merge branch 'feature/advanced_roaming_support' into 'master' 2024-04-02 00:02:41 +08:00
en change(camera): change esp_cam_del_ctlr to esp_cam_ctlr_del 2024-04-26 16:04:18 +08:00
zh_CN Merge branch 'docs/translate_mm_sync' into 'master' 2024-04-26 15:42:37 +08:00
check_lang_folder_sync.sh
component_info_ignore_file.txt docs(ulp): add info about lp-uart to lp-core docs 2023-10-23 12:11:34 +08:00
conf_common.py docs(usb): Add USBH maintainer notes 2024-04-23 17:18:56 +08:00
doxygen-known-warnings.txt change(freertos/idf): Update FreeRTOS documentation build 2023-10-21 04:39:17 +08:00
page_redirects.txt doc: remove left-over legacy event loop docs 2023-03-17 15:37:26 +08:00
README.md docs: Update example README template and other related docs 2024-04-15 17:17:27 +08:00
sphinx-known-warnings.txt fix(ble_mesh): Miscellaneous update for ble mesh 2023-09-16 15:58:14 +08:00
TEMPLATE_EXAMPLE_README.md docs: Improve sample project example 2024-04-26 13:42:30 +08:00

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