History

Angus Gratton a081e5d25e Merge branch 'bugfix/docs_what-you-need' into 'master' Updated 'What you need' picture See merge request idf/esp-idf!3725		2018-11-23 11:16:28 +08:00
..
_static	Updated 'What you need' picture	2018-11-16 22:18:31 +01:00
en	Merge branch 'bugfix/docs_https_server' into 'master'	2018-11-23 10:44:55 +08:00
zh_CN	docs: add pyparsing install to setup guide	2018-11-22 22:09:43 +08:00
check_doc_warnings.sh	Adjusted CI configuration to handle 'en' and 'zh_CN' language versions	2018-03-13 22:07:31 +01:00
check_lang_folder_sync.sh	Introduced a CI check if folders with localized documentation are in sync, i.e. if they contain the same list of files	2018-03-16 07:54:58 +01:00
conf_common.py	Merge branch 'bugfix/doc_builds_windows' into 'master'	2018-11-20 17:20:40 +08:00
docs_common.mk	Fix Python 3 compatibility issues	2018-10-24 11:20:54 +02:00
Doxyfile	esp_https_server : Docs and API references fixed	2018-11-19 04:00:21 +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	doc: Fix doc builds on Windows MINGW32, add some doc build documentation	2018-10-26 04:04:56 +00:00
requirements.txt	Encourage to install python packages without administrative rights	2018-09-11 08:54:37 +02:00
sphinx-known-warnings.txt	Upgraded Sphinx to latest release 1.6.5 that contains a fix to https://github.com/sphinx-doc/sphinx/issues/4041 . Upgraded Breathe to latest release 4.7.3 as well.	2017-10-31 22:57:39 +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.

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.