Historia

Angus Gratton fcf76320c8 docs: Start refactoring IDF-specific docs features into extensions Run the actual IDF build system to determine what components are linked for a particular target.		2020-02-07 16:37:12 +11:00
..
_static	docs: add API guide page about IDF Tools	2020-01-24 14:02:21 +01:00
en	esp32: add implementation of esp_timer based on TG0 LAC timer	2020-02-06 14:00:18 +08:00
idf_build_system	docs: Start refactoring IDF-specific docs features into extensions	2020-02-07 16:37:12 +11:00
zh_CN	docs: add API guide page about IDF Tools	2020-01-24 14:02:21 +01:00
Doxyfile	esp32: add implementation of esp_timer based on TG0 LAC timer	2020-02-06 14:00:18 +08:00
README.md	…
TEMPLATE_EXAMPLE_README.md	examples: Update system examples README	2019-08-28 16:19:40 +08:00
check_doc_warnings.sh	…
check_lang_folder_sync.sh	…
conf_common.py	docs: Start refactoring IDF-specific docs features into extensions	2020-02-07 16:37:12 +11:00
docs_common.mk	docs: Add ESP-IDF support period policy	2019-10-18 18:25:20 +11:00
gen-dxd.py	…
gen-toolchain-links.py	Introduce esp-2019r2 toolchain for both ESP32 and ESP32s2 targets	2019-11-04 16:14:57 +07:00
gen-version-specific-includes.py	…
html_redirects.py	…
kconfig_reference.py	docs: Start refactoring IDF-specific docs features into extensions	2020-02-07 16:37:12 +11:00
link-roles.py	…
local_util.py	…
page_redirects.txt	esp_netif: docs update to include tcpip_adapter migration guide	2019-11-25 08:32:11 +01:00
requirements.txt	docs: Fix nwdiag dependency for documentation build	2020-02-06 12:36:47 +01:00
sphinx-known-warnings.txt	doc: Remove duplicate ulp-cmake	2020-01-10 16:38:06 +11: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

Install make and doxygen for your platform (make may already be installed as an ESP-IDF prerequisite).
Change to either the docs/en or docs/zh_CN subdirectory and run make html
make will probably prompt you to run a python pip install step to get some other Python-related prerequisites. Run the command as shown, then re-run make html to build the docs.

For MSYS2 MINGW32 on Windows

If using Windows and the MSYS2 MINGW32 terminal, run this command before running "make html" the first time:

pacman -S doxygen mingw-w64-i686-python2-pillow

Note: Currently it is not possible to build docs on Windows without using a Unix-on-Windows layer such as MSYS2 MINGW32.