Wang Ning 168a623a07 Add translation for linker script generation 5 vuotta sitten
..
_static b85358e593 Updated index 5 vuotta sitten
en 168a623a07 Add translation for linker script generation 5 vuotta sitten
extensions 63b76a9d90 doc: custom list filter directive 6 vuotta sitten
idf_extensions a6b522c0f4 docs: Fix generation of links to examples 5 vuotta sitten
zh_CN 168a623a07 Add translation for linker script generation 5 vuotta sitten
Doxyfile 52d888a68b docs: Fix broken URLs & permanent redirects 5 vuotta sitten
README.md 416076665b docs: use new sphinx_idf_theme theme, add variables to allow theme to build version footer 5 vuotta sitten
TEMPLATE_EXAMPLE_README.md de682a13b1 examples: Update system examples README 6 vuotta sitten
build_docs.py 1a2ddcb77a docs: deploy docs to production server from CI 5 vuotta sitten
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 vuotta sitten
conf_common.py b497819667 docs: update esp32s2 summary page 5 vuotta sitten
doxygen-known-warnings.txt 11fac8637a docs: Resolve doxygen & Sphinx warnings 6 vuotta sitten
page_redirects.txt 3dec957bc8 doc: Create redirects for ESP32 hw-reference get-started URLs 5 vuotta sitten
requirements.txt 416076665b docs: use new sphinx_idf_theme theme, add variables to allow theme to build version footer 5 vuotta sitten
sanitize_version.py 1a2ddcb77a docs: deploy docs to production server from CI 5 vuotta sitten
sphinx-known-warnings.txt 11fac8637a docs: Resolve doxygen & Sphinx warnings 6 vuotta sitten

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

The documentation build requirements Python 3 and running the wrapper ./build_docs.py tool. Running ./build_docs.py --help will give a summary of available options.

See Documenting Code in the ESP-IDF Programming Guide for full information about setting up to build the docs, and how to use the ./build_docs.py tool.