Historia

David Čermák 2e4d5d8765 Merge branch 'feature/add_eth_lost_ip_event' into 'master' event: Add IP_EVENT_ETH_LOST_IP event Closes IDFGH-5198 See merge request espressif/esp-idf!13466		2021-05-10 07:27:16 +00:00
..
_static	docs: Update JTAG debugging guides for ESP32-C3	2021-04-13 12:48:50 +02:00
doxygen	vfs: add doc links	2021-04-15 15:19:00 +08:00
en	Merge branch 'feature/add_eth_lost_ip_event' into 'master'	2021-05-10 07:27:16 +00:00
extensions	doc: Add support for redirects to external URL	2021-04-27 17:01:24 +08:00
idf_extensions	Add warning to docs output if fastbuild	2021-05-06 09:17:41 +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 'feature/doc_fast_build' into 'master'	2021-05-06 03:56:56 +00:00
README.md	…
TEMPLATE_EXAMPLE_README.md	…
build_docs.py	docs: add fast build feature and activate it in CI	2021-04-28 16:32:35 +08:00
check_lang_folder_sync.sh	…
conf_common.py	* ets_delay_us(1) has too much overhead; change logic	2021-04-28 16:38:24 +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: Add support for redirects to external URL	2021-04-27 17:01:24 +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: Adds secure_boot_v2 for ESP32-C3 ECO3	2021-04-08 14:22:46 +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.