Historia

Jakob Hasse 1c3be690ed [esp_hw_support]: HMAC upstream support for S3		2021-08-13 12:01:06 +08:00
..
_static	docs/add_esp32-s2-devkitc-1_user_guide	2021-07-30 14:00:45 +08:00
doxygen	[esp_hw_support]: HMAC upstream support for S3	2021-08-13 12:01:06 +08:00
en	Merge branch 'docs/frameworks_and_libs_update' into 'master'	2021-08-12 10:25:22 +00:00
extensions	doc: Add support for redirects to external URL	2021-04-27 17:01:24 +08:00
idf_extensions	docs: add S3 TRM URL	2021-07-12 16:39:23 +08:00
latex_templates	…
test	docs: initial update of programming guide for C3	2021-02-01 15:40:02 +08:00
zh_CN	Merge branch 'docs/frameworks_and_libs_update' into 'master'	2021-08-12 10:25:22 +00:00
README.md	…
TEMPLATE_EXAMPLE_README.md	…
build_docs.py	build docs: enable building of S3 docs	2021-06-09 09:30:36 +08:00
check_lang_folder_sync.sh	…
conf_common.py	[esp_hw_support]: HMAC upstream support for S3	2021-08-13 12:01:06 +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	doc: update tinyusb document to support esp32s3	2021-07-22 10:43:10 +08:00
requirements.txt	docs: add warning for outdated versions	2021-04-27 09:02:11 +08:00
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: ignore duplicate def warning in BT docs	2021-06-30 15:10:43 +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.