Historia

Angus Gratton c572e0bf5f paritition_table: Verify the partition table md5sum when loading the app Additionally, always enable the partition MD5 check if flash encryption is on in Release mode. This ensures the partition table ciphertext has not been modified (CVE-2021-27926). The exception is pre-V3.1 ESP-IDF bootloaders and partition tables, which don't have support for the MD5 entry.		2021-06-02 16:30:02 +10:00
..
_static	docs: self host docs	2021-02-08 11:54:11 +08:00
en	paritition_table: Verify the partition table md5sum when loading the app	2021-06-02 16:30:02 +10:00
latex_templates	docs: self host docs	2021-02-08 11:54:11 +08:00
zh_CN	Backport CN translation for api-guides for v4.0	2021-04-23 15:52:58 +08:00
Doxyfile	docs: fix doxygen compile warnings for doxygen 1.9.1	2021-04-12 08:44:04 +08:00
README.md	…
TEMPLATE_EXAMPLE_README.md	…
check_doc_warnings.sh	…
check_lang_folder_sync.sh	…
conf_common.py	docs: self host docs	2021-02-08 11:54:11 +08:00
docs_common.mk	docs: Add ESP-IDF support period policy	2019-10-29 16:26:13 +11:00
gen-dxd.py	…
gen-toolchain-links.py	Introduce esp-2019r2 toolchain	2019-11-04 16:21:56 +07:00
gen-version-specific-includes.py	docs: self host docs	2021-02-08 11:54:11 +08:00
get_github_rev.py	docs: self host docs	2021-02-08 11:54:11 +08:00
html_redirects.py	…
issue_template.md	build system: Also get IDF version from annotated tags only	2020-10-07 13:55:53 +11:00
latex_builder.py	docs: self host docs	2021-02-08 11:54:11 +08:00
link-roles.py	docs: fix "link to translation" being broken	2021-03-22 13:55:21 +08:00
local_util.py	…
page_redirects.txt	…
requirements.txt	docs: self host docs	2021-02-08 11:54:11 +08:00
sanitize_version.py	docs: self host docs	2021-02-08 11:54:11 +08:00
sphinx-known-warnings.txt	…

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.