Adam Múdry d019bf0e32 Merge branch 'docs/remove_envvar_from_spi_flash_docs' into 'master' %!s(int64=2) %!d(string=hai) anos
..
_static 4215adcdb4 feat(cache): added cache msync doc %!s(int64=2) %!d(string=hai) anos
docs_not_updated 3d064c4d72 Merge branch 'docs/enable_ds_hmac_build_for_esp32p4' into 'master' %!s(int64=2) %!d(string=hai) anos
doxygen 321f628ff5 feat(gpio): add a dump API to dump IO configurations %!s(int64=2) %!d(string=hai) anos
en d019bf0e32 Merge branch 'docs/remove_envvar_from_spi_flash_docs' into 'master' %!s(int64=2) %!d(string=hai) anos
zh_CN d019bf0e32 Merge branch 'docs/remove_envvar_from_spi_flash_docs' into 'master' %!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
component_info_ignore_file.txt ebe68c3ee3 docs(build): add header include path and component require to api reference %!s(int64=2) %!d(string=hai) anos
conf_common.py d27dd4d9cb Merge branch 'docs/show_include_path' into 'master' %!s(int64=2) %!d(string=hai) anos
doxygen-known-warnings.txt 8c72daafa8 feat(mqtt): Updates submodule to 05b3476 %!s(int64=2) %!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 8eed3a2467 fix(ble_mesh): Miscellaneous update for ble mesh %!s(int64=2) %!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