Wang Ning b85358e593 Updated index		6 жил өмнө
..
_static	b85358e593 Updated index	6 жил өмнө
en	b85358e593 Updated index	6 жил өмнө
extensions	63b76a9d90 doc: custom list filter directive	6 жил өмнө
idf_extensions	dfc95bc78b docs: multi target include dir support	6 жил өмнө
zh_CN	b85358e593 Updated index	6 жил өмнө
Doxyfile	947e3e94ed Add ESP certificate bundle feature	6 жил өмнө
README.md	291735c7dd docs: Move to Python 3.5+ and Sphinx 2.3	6 жил өмнө
TEMPLATE_EXAMPLE_README.md	de682a13b1 examples: Update system examples README	6 жил өмнө
build_docs.py	ef7b5ff9e4 bugfix/build_docs_add_warning_check: Added null value check for warnings	6 жил өмнө
check_lang_folder_sync.sh	621076f329 Introduced a CI check if folders with localized documentation are in sync, i.e. if they contain the same list of files	8 жил өмнө
conf_common.py	f96c374254 Merge branch 'doc/multi_target_list' into 'master'	6 жил өмнө
doxygen-known-warnings.txt	11fac8637a docs: Resolve doxygen & Sphinx warnings	6 жил өмнө
page_redirects.txt	073ba0a608 feat/secure_boot_v2: Adding docs for secure boot v2 ESP32-ECO3	6 жил өмнө
requirements.txt	291735c7dd docs: Move to Python 3.5+ and Sphinx 2.3	6 жил өмнө
sphinx-known-warnings.txt	11fac8637a docs: Resolve doxygen & Sphinx warnings	6 жил өмнө

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.

Documentation build requres Python 3 and will not work with Python 2
Install dependencies for ESP-IDF as per the Getting Started guide
Install documentation Python depdendencies, ie pip install -r $IDF_PATH/docs/requirements.txt
Run ./build_docs.py build to build docs for all supported Language & Target combinations, or ./build_docs.py -t esp32 -l en build to build docs for a single supported language & target combination only.

See Documenting Code for more information.

Available languages are en and zh_CN, targets are any target supported by ESP-IDF - for example esp32 or esp32s2.