esp-idf/docs
Shen Meng Jing 20697f0f87 Merge branch 'docs/add_some_examples_to_i2c' into 'master'
docs: Add some application examples to i2c

Closes DOC-8018

See merge request espressif/esp-idf!31679
2024-06-25 13:19:46 +08:00
..
_static Merge branch 'docs/delete_user_guide_esp32_s2_devkitm_1' into 'master' 2024-06-19 17:28:59 +08:00
docs_not_updated Merge branch 'feature/support_parlio_on_c5' into 'master' 2024-06-20 19:16:12 +08:00
doxygen feat(lp-core): bringup lp-core for C5 MP 2024-06-19 09:18:47 +08:00
en Merge branch 'docs/add_some_examples_to_i2c' into 'master' 2024-06-25 13:19:46 +08:00
zh_CN Merge branch 'docs/add_some_examples_to_i2c' into 'master' 2024-06-25 13:19:46 +08:00
check_lang_folder_sync.sh
component_info_ignore_file.txt feat(ulp): support interrupts for C6/P4 LP core 2024-04-28 17:03:23 +08:00
conf_common.py docs(touch): add doc for cap touch sens driver 2024-06-12 15:44:25 +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: Update alerts in READMEs to GFM format 2024-05-06 15:19:15 +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