History

Krzysztof Budzynski 2fa24d6e39 Merge branch 'doc/hr-ref/gs-wrover-kit-v4.1-fix-header-name' into 'master' JP8 -> JP2 See merge request espressif/esp-idf!7053		2019-12-19 17:44:43 +08:00
..
_static	Fix the whitespace after everything which is link	2019-12-18 13:11:54 +08:00
en	Merge branch 'doc/hr-ref/gs-wrover-kit-v4.1-fix-header-name' into 'master'	2019-12-19 17:44:43 +08:00
zh_CN	Merge branch 'doc/hr-ref/gs-wrover-kit-v4.1-fix-header-name' into 'master'	2019-12-19 17:44:43 +08:00
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	Revert "docs: Temporarily allow cmake docs to be in English only"	2018-05-07 18:45:49 +08:00
conf_common.py	Generate source files for kconfiglib from the build system	2019-11-15 15:25:09 +00:00
docs_common.mk	docs: Add ESP-IDF support period policy	2019-10-18 18:25:20 +11:00
Doxyfile	esp_netif, docs: Added programmer's manual section	2019-12-17 09:02:51 +01:00
gen-dxd.py	docs: Correct Python coding style	2018-12-05 08:22:33 +01:00
gen-toolchain-links.py	Introduce esp-2019r2 toolchain for both ESP32 and ESP32s2 targets	2019-11-04 16:14:57 +07:00
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	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	Download font file only is not exists in target location	2019-05-21 09:51:39 +08:00
page_redirects.txt	esp_netif: docs update to include tcpip_adapter migration guide	2019-11-25 08:32:11 +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	doc: Limit sphinxcontrib versions to <2.0.0 as we use Sphinx 1.8.5	2019-12-11 14:34:18 +11:00
sphinx-known-warnings.txt	Added description for difference between ESP32 ULP and ESP32-S2 ULP	2019-12-13 18:38:57 +08:00
TEMPLATE_EXAMPLE_README.md	examples: Update system examples README	2019-08-28 16:19:40 +08: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.