Historia

Hrudaynath Dhabe d740769916 docs: wifi: wifi_guide update for disconnection warning in case of invalid initiation in `WIFI_MODE_APSTA`. Added warning to expect momentary disconnection of exSTA if channel of exAP is different than that of softAP and a prescribed solution.		2019-09-12 13:45:44 +08:00
..
_static	🐛 Fix the white space bug in docs	2019-08-09 10:07:22 +08:00
en	docs: wifi: wifi_guide update for disconnection warning in case of invalid initiation in `WIFI_MODE_APSTA`.	2019-09-12 13:45:44 +08:00
zh_CN	Add Chinese translation for README files in components and tools folders, including:	2019-09-06 20:18:19 +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	tools: Support sdkconfig.rename files from outside IDF in confgen.py	2019-07-16 20:18:19 +02: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.