History

Marius Vikhammer 1a90470f02 doc: Split HW-Reference into seperate files/folders for different chips		2020-02-07 16:37:44 +11:00
..
_static	docs: add API guide page about IDF Tools	2020-01-24 14:02:21 +01:00
en	doc: Split HW-Reference into seperate files/folders for different chips	2020-02-07 16:37:44 +11:00
extensions	doc: Changed toc filter reg.ex to be non-greedy	2020-02-07 16:37:43 +11:00
idf_extensions	doc: Add extension that replaces generic target variable with idf_target	2020-02-07 16:37:43 +11:00
zh_CN	doc: Split HW-Reference into seperate files/folders for different chips	2020-02-07 16:37:44 +11:00
build_docs.py	docs: Refactor extensions into packages, update the add-ons-reference docs page	2020-02-07 16:37:43 +11: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	doc: Split HW-Reference into seperate files/folders for different chips	2020-02-07 16:37:44 +11:00
Doxyfile	docs: Clear _Static_assert related warnings	2020-02-07 16:37:43 +11: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	docs: Refactor extensions into packages, update the add-ons-reference docs page	2020-02-07 16:37:43 +11:00
sphinx-known-warnings.txt	docs: Clear _Static_assert related warnings	2020-02-07 16:37:43 +11: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.