History

Angus Gratton d1373119e1 docs: Cleanup build warnings		2020-02-07 16:37:43 +11:00
..
_static	docs: add API guide page about IDF Tools	2020-01-24 14:02:21 +01:00
en	docs: Cleanup build warnings	2020-02-07 16:37:43 +11:00
idf_build_system	docs: add new top-level docs builder that builds docs for a single chip	2020-02-07 16:37:43 +11:00
zh_CN	docs: Add 'toctree filter' directive & filter out ESP32-only pages from S2 docs	2020-02-07 16:37:43 +11:00
build_docs.py	docs: Add "explicit only" directive & use only:: to block out some chip-specific parts of docs	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	docs: Mark some more docs sections as ESP32 only	2020-02-07 16:37:43 +11:00
Doxyfile	docs: Cleanup build warnings	2020-02-07 16:37:43 +11:00
doxygen_idf.py	docs: add new top-level docs builder that builds docs for a single chip	2020-02-07 16:37:43 +11:00
gen-dxd.py	docs: add new top-level docs builder that builds docs for a single chip	2020-02-07 16:37:43 +11: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: Move Doxygen build to a Sphinx extension, load sdkconfig & soc caps headers	2020-02-07 16:37:12 +11:00
include_build_file.py	docs: add new top-level docs builder that builds docs for a single chip	2020-02-07 16:37:43 +11:00
kconfig_reference.py	docs: add new top-level docs builder that builds docs for a single chip	2020-02-07 16:37:43 +11:00
link-roles.py	docs: Correct Python coding style	2018-12-05 08:22:33 +01:00
local_util.py	docs: Move Doxygen build to a Sphinx extension, load sdkconfig & soc caps headers	2020-02-07 16:37:12 +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: Add "explicit only" directive & use only:: to block out some chip-specific parts of docs	2020-02-07 16:37:43 +11:00
sphinx-known-warnings.txt	doc: Remove duplicate ulp-cmake	2020-01-10 16:38:06 +11:00
TEMPLATE_EXAMPLE_README.md	examples: Update system examples README	2019-08-28 16:19:40 +08:00
toctree_filter.py	docs: Add 'toctree filter' directive & filter out ESP32-only pages from S2 docs	2020-02-07 16:37:43 +11: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.