History

Angus Gratton 4e770aec61 Merge branch 'feature/predictable_event_dispatch_via_duplication' into 'master' Predictable event handler dispatch See merge request idf/esp-idf!3932		2019-02-05 08:47:03 +08:00
..
_static	spi_slave: improve the timing configuration	2019-01-26 00:10:41 +08:00
en	Merge branch 'feature/predictable_event_dispatch_via_duplication' into 'master'	2019-02-05 08:47:03 +08:00
zh_CN	Merge branch 'bugfix/add_missing_links_to_translation' into 'master'	2019-01-30 11:32:15 +08:00
check_doc_warnings.sh	Adjusted CI configuration to handle 'en' and 'zh_CN' language versions	2018-03-13 22:07:31 +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	docs: remove invalid arg in confgen invocation on docs generation	2019-01-16 08:16:09 +08:00
docs_common.mk	Fix Python 3 compatibility issues	2018-10-24 11:20:54 +02:00
Doxyfile	ethernet: support new PHY (IP101)	2019-01-29 14:08:35 +08:00
gen-dxd.py	docs: Correct Python coding style	2018-12-05 08:22:33 +01:00
gen-toolchain-links.py	docs: Correct Python coding style	2018-12-05 08:22:33 +01:00
gen-version-specific-includes.py	docs: Make Getting Started (CMake) guides version-aware	2018-12-21 19:13:20 +11:00
html_redirects.py	docs: Add option to redirect documentation pages which have moved	2018-12-18 14:07:43 +11:00
issue_template.md	doc: include compiler version in issue template	2018-10-26 12:47:32 +08:00
link-roles.py	docs: Correct Python coding style	2018-12-05 08:22:33 +01:00
local_util.py	docs: Correct Python coding style	2018-12-05 08:22:33 +01:00
README.md	doc: Fix doc builds on Windows MINGW32, add some doc build documentation	2018-10-26 04:04:56 +00:00
requirements.txt	Encourage to install python packages without administrative rights	2018-09-11 08:54:37 +02:00
sphinx-known-warnings.txt	Upgraded Sphinx to latest release 1.6.5 that contains a fix to https://github.com/sphinx-doc/sphinx/issues/4041 . Upgraded Breathe to latest release 4.7.3 as well.	2017-10-31 22:57:39 +01:00
TEMPLATE_EXAMPLE_README.md	docs: Add "Creating Examples" docs page, template example README	2018-06-14 16:49:22 +10: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.