esp-idf/docs
2024-08-13 12:04:43 +08:00
..
_static docs: remove user guide for esp32-pico-kit related docs after migration 2024-08-12 17:17:14 +08:00
docs_not_updated Merge branch 'feat/add_dedic_gpio_support_on_c61' into 'master' 2024-08-09 11:37:44 +08:00
doxygen docs: Provide CN translation for camera_driver.rst 2024-08-01 11:52:29 +08:00
en docs: Update the application examples in mcpwm.rst 2024-08-13 12:04:43 +08:00
zh_CN docs: Update the application examples in mcpwm.rst 2024-08-13 12:04:43 +08:00
check_lang_folder_sync.sh global: use '/usr/bin/env bash' instead of '/usr/bin/bash' in shebangs 2020-04-03 01:10:02 +02:00
component_info_ignore_file.txt feat(lp-spi): Added support for LP SPI driver to the LP Core on esp32p4 2024-06-26 13:43:55 +02:00
conf_common.py docs(ble): Added BLE feature support status 2024-08-09 17:13:12 +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