esp-idf/docs
Omar Chebib c68c404cdc Merge branch 'fix/xtensa_nmi' into 'master'
fix(esp_hw_support): make the NMI interrupts available for the main application

Closes IDF-1891 and IDFGH-12631

See merge request espressif/esp-idf!32767
2024-09-02 11:18:32 +08:00
..
_static [BT-3811] Added BLE Get Started 2024-08-27 09:41:50 +08:00
docs_not_updated change(twai): removal c61 twai due to not exist 2024-08-29 21:23:50 +08:00
doxygen feat(isp): added demosaic programming guide 2024-08-29 10:46:37 +08:00
en Merge branch 'fix/xtensa_nmi' into 'master' 2024-09-02 11:18:32 +08:00
zh_CN Merge branch 'change/improve_some_wifi_releated_introduction' into 'master' 2024-08-31 14:58:48 +08:00
check_lang_folder_sync.sh
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 [BT-3811] Added BLE Get Started 2024-08-27 09:41:50 +08:00
doxygen-known-warnings.txt change(freertos/idf): Update FreeRTOS documentation build 2023-10-21 04:39:17 +08:00
page_redirects.txt
README.md docs: Update example README template and other related docs 2024-04-15 17:17:27 +08:00
sphinx-known-warnings.txt
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