Anton Maklakov 8046df875e docs: Fixup format of a command line to build unit tests 6 gadi atpakaļ
..
_static b85358e593 Updated index 5 gadi atpakaļ
en 8046df875e docs: Fixup format of a command line to build unit tests 5 gadi atpakaļ
extensions 63b76a9d90 doc: custom list filter directive 6 gadi atpakaļ
idf_extensions 296a1db3c6 docs: Update link_to_translation to work with targets & new URL scheme 5 gadi atpakaļ
zh_CN 8046df875e docs: Fixup format of a command line to build unit tests 5 gadi atpakaļ
Doxyfile 207914a13a Merge branch 'refactor/common_code_panic_handler' into 'master' 5 gadi atpakaļ
README.md 416076665b docs: use new sphinx_idf_theme theme, add variables to allow theme to build version footer 5 gadi atpakaļ
TEMPLATE_EXAMPLE_README.md de682a13b1 examples: Update system examples README 6 gadi atpakaļ
build_docs.py 1a2ddcb77a docs: deploy docs to production server from CI 5 gadi atpakaļ
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 7 gadi atpakaļ
conf_common.py b497819667 docs: update esp32s2 summary page 5 gadi atpakaļ
doxygen-known-warnings.txt 11fac8637a docs: Resolve doxygen & Sphinx warnings 6 gadi atpakaļ
page_redirects.txt 073ba0a608 feat/secure_boot_v2: Adding docs for secure boot v2 ESP32-ECO3 6 gadi atpakaļ
requirements.txt 416076665b docs: use new sphinx_idf_theme theme, add variables to allow theme to build version footer 5 gadi atpakaļ
sanitize_version.py 1a2ddcb77a docs: deploy docs to production server from CI 5 gadi atpakaļ
sphinx-known-warnings.txt 11fac8637a docs: Resolve doxygen & Sphinx warnings 6 gadi atpakaļ

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.