Shang Zhou 256c8a103e docs: update CN translation for build-system.rst %!s(int64=3) %!d(string=hai) anos
..
_static 4019e307f1 doc: add api reference for etm driver %!s(int64=3) %!d(string=hai) anos
docs_not_updated 8277a8e8df doc: gpio glitch filter %!s(int64=3) %!d(string=hai) anos
doxygen 8277a8e8df doc: gpio glitch filter %!s(int64=3) %!d(string=hai) anos
en 256c8a103e docs: update CN translation for build-system.rst %!s(int64=3) %!d(string=hai) anos
zh_CN 256c8a103e docs: update CN translation for build-system.rst %!s(int64=3) %!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 4019e307f1 doc: add api reference for etm driver %!s(int64=3) %!d(string=hai) anos
doxygen-known-warnings.txt c8617fe965 docs: fix all doxygen warnings %!s(int64=3) %!d(string=hai) anos
page_redirects.txt 8d637ec985 doc: redirect console page %!s(int64=3) %!d(string=hai) anos
sphinx-known-warnings.txt 17224f3254 component manager: add build property `DEPENDENCIES_LOCK` %!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