esp-idf/docs
Zhang Xiao Yan 96c81c87bf Merge branch 'docs/add_two_terms_flash_psram_config' into 'master'
docs: add two terms to api-guides/flash_psram_config

See merge request espressif/esp-idf!30100
2024-04-09 18:45:06 +08:00
..
_static feat(esp_eth): Added support of internal EMAC for ESP32P4 2024-01-16 14:29:25 +01:00
docs_not_updated docs(security): Update security-related docs for ESP32-P4 2024-04-01 17:34:28 +05:30
doxygen Merge branch 'feature/advanced_roaming_support' into 'master' 2024-04-02 00:02:41 +08:00
en Merge branch 'docs/add_two_terms_flash_psram_config' into 'master' 2024-04-09 18:45:06 +08:00
zh_CN Merge branch 'docs/translate_cloud-framework' into 'master' 2024-04-09 18:37:09 +08:00
README.md
TEMPLATE_EXAMPLE_README.md
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: 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
sphinx-known-warnings.txt fix(ble_mesh): Miscellaneous update for ble mesh 2023-09-16 15:58:14 +08:00

README.md

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

The above URLs are all for the master branch latest version. Click the drop-down in the bottom left to choose a stable version or to download a PDF.

Building Documentation

The documentation is built using the python package esp-docs, which can be installed by running pip install esp-docs. Running build-docs --help will give a summary of available options. For more information see the esp-docs documentation at https://github.com/espressif/esp-docs/blob/master/README.md