Historia

Marius Vikhammer c6934d6175 MQTT: update default broker URL for examples The MQTT broker URL used as default in the examples has ceased operation. All examples and documention have been updated to point to the new domain mqtt.eclipse.org. This also required an update of the python example test scripts to use TLS 1.2		2019-10-15 09:35:23 +00:00
..
_static	esp_ringbuf: add documents for SendAcquire and SendComplete	2019-10-11 15:44:27 +08:00
en	MQTT: update default broker URL for examples	2019-10-15 09:35:23 +00:00
zh_CN	Update board getting started guides to make cmake default	2019-10-15 17:15:15 +08:00
Doxyfile	…
README.md	…
TEMPLATE_EXAMPLE_README.md	examples: Update system examples README	2019-08-28 16:19:40 +08:00
check_doc_warnings.sh	…
check_lang_folder_sync.sh	…
conf_common.py	Allow the extension for adding todo notes to rst files. Add information on how to use this extension to the contribution section.	2019-09-11 17:15:00 +08:00
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	…
page_redirects.txt	…
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.