History

Angus Gratton 6f7be93d53 Merge branch 'bugfix/cmake_convert_whitespace' into 'master' cmake: Minor convert_to_cmake.py fixes See merge request espressif/esp-idf!7066		2020-03-02 14:22:37 +08:00
..
_static	docs: add API guide page about IDF Tools	2020-01-24 14:02:21 +01:00
en	Merge branch 'bugfix/cmake_convert_whitespace' into 'master'	2020-03-02 14:22:37 +08:00
extensions	doc: custom list filter directive	2020-02-20 18:08:05 +08:00
idf_extensions	docs: Check local files exist (and are correct type) for custom link roles	2020-02-18 10:34:11 +11:00
zh_CN	docs: Include feedback link in footer	2020-02-29 16:20:41 +08:00
build_docs.py	bugfix/build_docs_add_warning_check: Added null value check for warnings	2020-02-12 12:32:41 +05:30
check_lang_folder_sync.sh	Introduced a CI check if folders with localized documentation are in sync, i.e. if they contain the same list of files	2018-03-16 07:54:58 +01:00
conf_common.py	Merge branch 'doc/multi_target_list' into 'master'	2020-02-28 11:57:55 +08:00
Doxyfile	soc: separate abstraction, description and implementation	2020-02-11 14:30:42 +05:00
doxygen-known-warnings.txt	docs: Resolve doxygen & Sphinx warnings	2020-02-07 16:37:45 +11:00
page_redirects.txt	feat/secure_boot_v2: Adding docs for secure boot v2 ESP32-ECO3	2020-02-25 01:28:22 +05:30
README.md	docs: Move to Python 3.5+ and Sphinx 2.3	2020-02-07 16:47:50 +11:00
requirements.txt	docs: Move to Python 3.5+ and Sphinx 2.3	2020-02-07 16:47:50 +11:00
sphinx-known-warnings.txt	docs: Resolve doxygen & Sphinx warnings	2020-02-07 16:37:45 +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

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.