Dai Zi Yan 9998e88ada Merge branch 'docs/add_GPIO_list_for_each_chip' into 'master' 4 년 전
..
_static baebf74342 docs/add_esp32-s2-devkitc-1_user_guide 4 년 전
doxygen f38b18f046 docs: Separate Doc on WiFi security, added DPP Doc 4 년 전
en 9998e88ada Merge branch 'docs/add_GPIO_list_for_each_chip' into 'master' 4 년 전
extensions 50fe1eea15 doc: Add support for redirects to external URL 4 년 전
idf_extensions 42e303a6f9 docs: add S3 TRM URL 4 년 전
latex_templates 66fb5a29bb Whitespace: Automated whitespace fixes (large commit) 5 년 전
test 548fd02d10 docs: initial update of programming guide for C3 5 년 전
zh_CN f38b18f046 docs: Separate Doc on WiFi security, added DPP Doc 4 년 전
README.md 416076665b docs: use new sphinx_idf_theme theme, add variables to allow theme to build version footer 5 년 전
TEMPLATE_EXAMPLE_README.md de682a13b1 examples: Update system examples README 6 년 전
build_docs.py bdfda351bd build docs: enable building of S3 docs 4 년 전
check_lang_folder_sync.sh e94288da31 global: use '/usr/bin/env bash' instead of '/usr/bin/bash' in shebangs 5 년 전
conf_common.py 2218204aa7 doc: update tinyusb document to support esp32s3 4 년 전
doxygen-known-warnings.txt 11fac8637a docs: Resolve doxygen & Sphinx warnings 6 년 전
generate_chart.py 0146f258d7 style: format python files with isort and double-quote-string-fixer 5 년 전
get_github_rev.py 214f1fbbed docs: add 'edit-on-github' link to html theme 5 년 전
page_redirects.txt 2218204aa7 doc: update tinyusb document to support esp32s3 4 년 전
requirements.txt e8b7d2ca08 docs: add warning for outdated versions 4 년 전
sanitize_version.py 0146f258d7 style: format python files with isort and double-quote-string-fixer 5 년 전
sphinx-known-warnings.txt e07be3df49 docs: ignore duplicate def warning in BT docs 4 년 전

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.