Historia

Angus Gratton da390618c2 cmake: Fix psram workaround compiler flag application Previously, this compiler flag was not being applied regardless of CONFIG_SPIRAM_CACHE_WORKAROUND setting. Explanation: add_compile_options() only applies to source files added after the function is run, or in subdirectories added after the function is run. In this case, no new source files were being added after this function was run.		2019-02-26 04:07:51 +00:00
..
_static	spi_slave: improve the timing configuration	2019-01-26 00:10:41 +08:00
en	cmake: Fix psram workaround compiler flag application	2019-02-26 04:07:51 +00:00
zh_CN	Merge branch 'feature/docs_add-ons_and_extensions' into 'master'	2019-02-19 06:06:31 +08:00
Doxyfile	ethernet: support new PHY (IP101)	2019-01-29 14:08:35 +08:00
README.md	…
TEMPLATE_EXAMPLE_README.md	…
check_doc_warnings.sh	…
check_lang_folder_sync.sh	…
conf_common.py	docs: remove invalid arg in confgen invocation on docs generation	2019-01-16 08:16:09 +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	docs: Add option to redirect documentation pages which have moved	2018-12-18 14:07:43 +11:00
issue_template.md	…
link-roles.py	…
local_util.py	…
requirements.txt	…
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.