Cai Xin Ying cf3e19019e Docs/add Chinese translation for api-reference/network/esp_netif.rst %!s(int64=2) %!d(string=hai) anos
..
_static 024b58604a docs: Describe the approach of fatfsgen.py and fatfsparse.py %!s(int64=2) %!d(string=hai) anos
docs_not_updated 0d1fd8ce44 idocs: updated Storage API reference documents for ESP32H2 %!s(int64=2) %!d(string=hai) anos
doxygen a4e8960ab4 esp_clk_tree: Rename clk_tree_xxx to esp_clk_tree_xxx, add compilation warning to clk_tree.h %!s(int64=2) %!d(string=hai) anos
en cf3e19019e Docs/add Chinese translation for api-reference/network/esp_netif.rst %!s(int64=2) %!d(string=hai) anos
zh_CN cf3e19019e Docs/add Chinese translation for api-reference/network/esp_netif.rst %!s(int64=2) %!d(string=hai) anos
README.md 7411321603 docs: update to use esp-docs %!s(int64=4) %!d(string=hai) anos
TEMPLATE_EXAMPLE_README.md 5f7733f692 docs: update frontpage/general pages for ESP8684 %!s(int64=4) %!d(string=hai) anos
check_lang_folder_sync.sh e94288da31 global: use '/usr/bin/env bash' instead of '/usr/bin/bash' in shebangs %!s(int64=5) %!d(string=hai) anos
conf_common.py 359b237cc5 ulp: added sleep support for lp core %!s(int64=2) %!d(string=hai) anos
doxygen-known-warnings.txt c318c89453 freertos(IDF): Remove dependency on portUSING_MPU_WRAPPERS %!s(int64=3) %!d(string=hai) anos
page_redirects.txt a44671c11a doc: remove left-over legacy event loop docs %!s(int64=2) %!d(string=hai) anos
sphinx-known-warnings.txt 2cf9236f6c heap trace standalone: Fix initialization of the unused linked list, update tests %!s(int64=3) %!d(string=hai) anos

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