History

Jiang Jiang Jian 7aee8722fe Merge branch 'bugfix/msys2_toolchain_path_note_v3.2' into 'release/v3.2' docs: update windows msys2 installer notes to unzip all-in-one toolchain to path without spaces (v3.2) See merge request espressif/esp-idf!6458		2019-10-25 11:36:29 +08:00
..
_static	Replace gif images on EN and zh_CN index pages with identical png images for successful building of PDFs on ReadTheDocs.	2019-07-30 14:19:20 +08:00
en	docs: update windows msys2 installer notes to unzip all-in-one toolchain to path without spaces (v3.2)	2019-10-22 21:17:00 +02:00
zh_CN	Replace gif images on EN and zh_CN index pages with identical png images for successful building of PDFs on ReadTheDocs.	2019-07-30 14:19:20 +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. (backport v3.2)	2019-02-27 23:21:47 +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-25 14:11:35 +08:00
docs_common.mk	Fix Python 3 compatibility issues	2018-10-24 11:20:54 +02:00
Doxyfile	mqtt: referenced esp-mqtt master to fix disconnect crash issue and	2019-10-21 05:49:54 +00:00
gen-dxd.py	docs: Make the Python scripts Python 2&3 compatible	2018-09-10 08:37:43 +02:00
gen-toolchain-links.py	docs: fix instructions for building toolchain on macOS	2018-10-26 12:42:38 +08:00
gen-version-specific-includes.py	Fix Python 3 compatibility issues	2018-10-24 11:20:54 +02:00
issue_template.md	doc: include compiler version in issue template	2018-10-26 12:47:32 +08:00
link-roles.py	docs: Make the Python scripts Python 2&3 compatible	2018-09-10 08:37:43 +02:00
local_util.py	docs: Make the Python scripts Python 2&3 compatible	2018-09-10 08:37:43 +02:00
README.md	Replace all DOS line endings with Unix	2018-07-12 19:10:37 +08:00
requirements.txt	Fix Breathe version to avoid docs build failure on ReadTheDocs server. Provide RTD project configuration file to be able to select python version for specific esp-idf release. (backport v3.2)	2019-05-23 19:57:43 +08:00
sphinx-known-warnings.txt	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. (backport v3.2)	2019-02-27 23:21:47 +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.