Historia

Angus Gratton 8e91677701 Merge branch 'bugfix/bootloader_flash_crypt_cnt_ff' into 'master' flash encryption: reduce FLASH_CRYPT_CNT bit width to 7 bits See merge request idf/esp-idf!4642		2019-04-09 08:10:06 +08:00
..
_static	Updated 404 page not found pages, both Chinese and English versions.	2019-03-28 19:06:43 +08:00
en	Merge branch 'bugfix/bootloader_flash_crypt_cnt_ff' into 'master'	2019-04-09 08:10:06 +08:00
zh_CN	Fix a very important typo that cannot wait	2019-04-03 18:34:34 +08:00
Doxyfile	misc adjustment of esp32 component	2019-04-03 19:57:46 +08:00
README.md	…
TEMPLATE_EXAMPLE_README.md	…
check_doc_warnings.sh	…
check_lang_folder_sync.sh	…
conf_common.py	…
docs_common.mk	…
gen-dxd.py	…
gen-toolchain-links.py	…
gen-version-specific-includes.py	…
html_redirects.py	…
issue_template.md	…
link-roles.py	…
local_util.py	…
requirements.txt	docs: Introduced custom 404 page in readthedocs documentation to replace…	2019-03-28 01:38:31 +08:00
sphinx-known-warnings.txt	…

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.

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.

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.