Historia

Angus Gratton 37d5e2fba6 docs: Add "explicit only" directive & use only:: to block out some chip-specific parts of docs		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: Add "explicit only" directive & use only:: to block out some chip-specific parts of docs	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 new top-level docs builder that builds docs for a single chip	2020-02-07 16:37:43 +11:00
Doxyfile	docs: add new top-level docs builder that builds docs for a single chip	2020-02-07 16:37:43 +11:00
README.md	…
TEMPLATE_EXAMPLE_README.md	…
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	…
check_lang_folder_sync.sh	…
conf_common.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
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	…
gen-version-specific-includes.py	…
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	…
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	…
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	…

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.