Cai Xin Ying e93672bc7b docs: Provide CN translation for api-reference/system/heap_debug.rst 2 年之前
..
_static 15153b5598 spi_flash: Update documents for flash-suspend 2 年之前
docs_not_updated 843107e9d6 docs: update esp32c6 api guides about wifi part 2 年之前
doxygen a06118012e docs: Update `nvs_flash` docs for the HMAC-based NVS encr-keys protection scheme 2 年之前
en e93672bc7b docs: Provide CN translation for api-reference/system/heap_debug.rst 2 年之前
zh_CN e93672bc7b docs: Provide CN translation for api-reference/system/heap_debug.rst 2 年之前
README.md 7411321603 docs: update to use esp-docs 4 年之前
TEMPLATE_EXAMPLE_README.md 5f7733f692 docs: update frontpage/general pages for ESP8684 4 年之前
check_lang_folder_sync.sh e94288da31 global: use '/usr/bin/env bash' instead of '/usr/bin/bash' in shebangs 5 年之前
conf_common.py 843107e9d6 docs: update esp32c6 api guides about wifi part 2 年之前
doxygen-known-warnings.txt c318c89453 freertos(IDF): Remove dependency on portUSING_MPU_WRAPPERS 3 年之前
page_redirects.txt a44671c11a doc: remove left-over legacy event loop docs 2 年之前
sphinx-known-warnings.txt 2cf9236f6c heap trace standalone: Fix initialization of the unused linked list, update tests 3 年之前

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