Historia

Sachin Parekh 4de5ae7468 PM: I2S and I2C added in the Power Management docs Signed-off-by: Sachin Parekh <sachin.parekh@espressif.com>		2019-03-18 08:21:21 +00:00
..
_static	doc/jtag_debug: translation of jtag debugging	2019-01-30 11:34:04 +08:00
en	PM: I2S and I2C added in the Power Management docs	2019-03-18 08:21:21 +00:00
zh_CN	Merge branch 'bugfix/name_conflict_esp32_project_ld' into 'master'	2019-03-15 11:42:20 +08:00
Doxyfile	docs: Add efuse	2019-02-28 07:31:29 +00:00
README.md	…
TEMPLATE_EXAMPLE_README.md	…
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	…
conf_common.py	Update IDF getting started sections for make and cmake as well as IDF monitor…	2019-03-14 00:10:26 +08:00
docs_common.mk	…
gen-dxd.py	…
gen-toolchain-links.py	…
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	…
issue_template.md	…
link-roles.py	…
local_util.py	…
requirements.txt	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
sphinx-known-warnings.txt	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

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.