Historia

sU8U7SfkcwTJVH7PjaVmej7D 6673407f98 httpd_resp_send: use `HTTPD_RESP_USE_STRLEN` when possible		2020-07-13 05:34:56 +00:00
..
_static	TWAI: Add ESP32-S2 support	2020-06-30 16:56:03 +08:00
en	httpd_resp_send: use `HTTPD_RESP_USE_STRLEN` when possible	2020-07-13 05:34:56 +00:00
extensions	…
idf_extensions	docs: fix link_roles not linking correctly for certain files	2020-06-22 20:42:59 +08:00
latex_templates	…
zh_CN	httpd_resp_send: use `HTTPD_RESP_USE_STRLEN` when possible	2020-07-13 05:34:56 +00:00
Doxyfile	spi_slave_hd: new driver for spi slave in half duplex mode	2020-07-11 00:00:50 +08:00
README.md	…
TEMPLATE_EXAMPLE_README.md	…
build_docs.py	docs: fix check_docs not working for multiple builders	2020-05-29 20:10:18 +08:00
check_lang_folder_sync.sh	…
conf_common.py	spi_slave_hd: new driver for spi slave in half duplex mode	2020-07-11 00:00:50 +08:00
doxygen-known-warnings.txt	…
get_github_rev.py	…
page_redirects.txt	TWAI: Add ESP32-S2 support	2020-06-30 16:56:03 +08:00
requirements.txt	docs: update sphinx_idf_theme documentation	2020-07-06 10:45:43 +08:00
sanitize_version.py	…
sphinx-known-warnings.txt	docs: fix check_docs not working for multiple builders	2020-05-29 20:10:18 +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.