esp-idf/docs
Jiang Jiang Jian 64c41c82cb Merge branch 'docs/update_build_system' into 'master'
docs: update a typo in the build system document

Closes DOC-6637

See merge request espressif/esp-idf!29969
2024-04-17 10:41:55 +08:00
..
_static docs(jpeg): Add full-content of jpeg decoder and encoder programming guide 2024-04-11 10:22:01 +08:00
docs_not_updated doc(jtag): update esp32p4 jtag debugging guide 2024-04-04 21:37:56 +03:00
doxygen Merge branch 'feature/advanced_roaming_support' into 'master' 2024-04-02 00:02:41 +08:00
en Merge branch 'docs/update_build_system' into 'master' 2024-04-17 10:41:55 +08:00
zh_CN Merge branch 'docs/update_build_system' into 'master' 2024-04-17 10:41:55 +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 docs(ulp): add info about lp-uart to lp-core docs 2023-10-23 12:11:34 +08:00
conf_common.py docs: disable build phy.rst for esp32p4 2024-04-01 14:59:57 +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 example README template and other related docs 2024-04-15 17:17:27 +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