Roland Dobai 5c0cd9417d Docs: Encourage to used Python 3		пре 6 година
..
_static	1cd6f67679 docs: add API guide page about IDF Tools	пре 6 година
en	5c0cd9417d Docs: Encourage to used Python 3	пре 6 година
extensions	e06a57f34f doc: Changed toc filter reg.ex to be non-greedy	пре 6 година
idf_extensions	a825985283 docs: Check local files exist (and are correct type) for custom link roles	пре 6 година
zh_CN	5c0cd9417d Docs: Encourage to used Python 3	пре 6 година
Doxyfile	1f2e2fe8af soc: separate abstraction, description and implementation	пре 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	291735c7dd docs: Move to Python 3.5+ and Sphinx 2.3	пре 6 година
doxygen-known-warnings.txt	11fac8637a docs: Resolve doxygen & Sphinx warnings	пре 6 година
page_redirects.txt	1a012b7ad2 esp_netif: docs update to include tcpip_adapter migration guide	пре 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.

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.

README.md

Documentation Source Folder

Hosted Documentation

Building Documentation