Historia

Renz Bagaporo 813044c6db docs, ci: update docs and ci with movements from esp_common		2021-02-24 12:16:37 +08:00
..
_static	touch_element: add touch element api-reference doc	2021-02-22 12:16:49 +08:00
doxygen	docs, ci: update docs and ci with movements from esp_common	2021-02-24 12:16:37 +08:00
en	docs, ci: update docs and ci with movements from esp_common	2021-02-24 12:16:37 +08:00
extensions	style: format python files with isort and double-quote-string-fixer	2021-01-26 10:49:01 +08:00
idf_extensions	docs: initial update of programming guide for C3	2021-02-01 15:40:02 +08:00
latex_templates	…
test	docs: initial update of programming guide for C3	2021-02-01 15:40:02 +08:00
zh_CN	touch_element: add touch element api-reference doc	2021-02-22 12:16:49 +08:00
README.md	…
TEMPLATE_EXAMPLE_README.md	…
build_docs.py	docs: initial update of programming guide for C3	2021-02-01 15:40:02 +08:00
check_lang_folder_sync.sh	…
conf_common.py	touch_element: add touch element api-reference doc	2021-02-22 12:16:49 +08:00
doxygen-known-warnings.txt	…
generate_chart.py	style: format python files with isort and double-quote-string-fixer	2021-01-26 10:49:01 +08:00
get_github_rev.py	…
page_redirects.txt	…
requirements.txt	…
sanitize_version.py	style: format python files with isort and double-quote-string-fixer	2021-01-26 10:49:01 +08:00
sphinx-known-warnings.txt	docs: initial update of programming guide for C3	2021-02-01 15:40:02 +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 build requirements Python 3 and running the wrapper ./build_docs.py tool. Running ./build_docs.py --help will give a summary of available options.

See Documenting Code in the ESP-IDF Programming Guide for full information about setting up to build the docs, and how to use the ./build_docs.py tool.