History

Angus Gratton f5a7c9635f Merge branch 'feature/msys2_env_update_v4.1' into 'release/v4.1' windows: Update MSYS2 pre-compiled legacy build environment (v4.1) See merge request espressif/esp-idf!9143		2020-07-08 17:34:33 +08:00
..
_static	ble_mesh: Doc miscellaneous fixes	2020-05-21 17:46:28 +08:00
en	Merge branch 'feature/msys2_env_update_v4.1' into 'release/v4.1'	2020-07-08 17:34:33 +08:00
zh_CN	Merge branch 'feature/msys2_env_update_v4.1' into 'release/v4.1'	2020-07-08 17:34:33 +08:00
check_doc_warnings.sh	docs: Preparation for upgrade of Sphinx and Breathe packages to versions 1.8.4 and 4.11.1. Updated check of Sphinx warnings to account for the filename instead of the whole path, that for the same errors may be different between English and Chinese docs.	2019-02-27 22:11:59 +01:00
check_lang_folder_sync.sh	Revert "docs: Temporarily allow cmake docs to be in English only"	2018-05-07 18:45:49 +08:00
conf_common.py	gh_action: fix python lint	2020-06-24 13:17:29 +08:00
docs_common.mk	docs: Add ESP-IDF support period policy	2019-10-18 18:25:20 +11:00
Doxyfile	Merge branch 'refactor/can_driver' into 'master'	2020-01-10 14:22:02 +08:00
gen-dxd.py	docs: Correct Python coding style	2018-12-05 08:22:33 +01:00
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	doc: Fix invalid 'This command will clone master' note in docs	2019-02-19 04:05:39 +00:00
html_redirects.py	docs: Add option to redirect documentation pages which have moved	2018-12-18 14:07:43 +11:00
link-roles.py	docs: Correct Python coding style	2018-12-05 08:22:33 +01:00
local_util.py	Download font file only is not exists in target location	2019-05-21 09:51:39 +08:00
page_redirects.txt	feat/secure_boot_v2: Adding docs for secure boot v2 ESP32-ECO3	2020-03-06 01:16:04 +05:30
README.md	doc: Fix doc builds on Windows MINGW32, add some doc build documentation	2018-10-26 04:04:56 +00:00
requirements.txt	Docs: Fix sphinxcontrib dependencies	2020-02-13 14:50:31 +01:00
sphinx-known-warnings.txt	doc: Remove duplicate ulp-cmake	2020-01-10 16:38:06 +11:00
TEMPLATE_EXAMPLE_README.md	examples: Update system examples README	2019-08-28 16:19:40 +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

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.