esp-idf/docs
Angus Gratton 9ebb48ff9d Merge branch 'bugfix/idf_fullclean_loses_target' into 'master'
idf.py: guess IDF_TARGET from sdkconfig/sdkconfig.defaults, error out if IDF_TARGET is inconsistent

Closes IDF-869 and IDF-1040

See merge request espressif/esp-idf!7486
2020-02-05 07:41:11 +08:00
..
_static docs: add API guide page about IDF Tools 2020-01-24 14:02:21 +01:00
en docs: update build system guide on setting IDF_TARGET 2020-01-31 10:19:44 +01:00
zh_CN docs: add API guide page about IDF Tools 2020-01-24 14:02:21 +01:00
Doxyfile
README.md
TEMPLATE_EXAMPLE_README.md
check_doc_warnings.sh
check_lang_folder_sync.sh
conf_common.py Docs: Omit kconfig configurations not available for the target 2020-01-30 10:30:06 +01:00
docs_common.mk
gen-dxd.py
gen-toolchain-links.py
gen-version-specific-includes.py
html_redirects.py
link-roles.py
local_util.py
page_redirects.txt
requirements.txt
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.