Krzysztof Budzynski 58424ccebf Merge branch 'bugfix/doc_jtag_c3' into 'master'		4 년 전
..
_static	a2cf1a7d38 docs: Update JTAG debugging guides for ESP32-C3	4 년 전
doxygen	40035edcac vfs: add doc links	4 년 전
en	58424ccebf Merge branch 'bugfix/doc_jtag_c3' into 'master'	4 년 전
extensions	440fab3d6e docs: add google analytics tracking	4 년 전
idf_extensions	1ff2c834ce docs: add C3 TRM links	4 년 전
latex_templates	66fb5a29bb Whitespace: Automated whitespace fixes (large commit)	5 년 전
test	548fd02d10 docs: initial update of programming guide for C3	5 년 전
zh_CN	58424ccebf Merge branch 'bugfix/doc_jtag_c3' into 'master'	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	548fd02d10 docs: initial update of programming guide for C3	5 년 전
check_lang_folder_sync.sh	e94288da31 global: use '/usr/bin/env bash' instead of '/usr/bin/bash' in shebangs	5 년 전
conf_common.py	a2cf1a7d38 docs: Update JTAG debugging guides for ESP32-C3	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	962ea8b9f2 docs: repurpose WROVER-KIT debugging guide for Kaluga-1	5 년 전
requirements.txt	4e9d810dfb Docs: build doc with new layout for target and version select	4 년 전
sanitize_version.py	0146f258d7 style: format python files with isort and double-quote-string-fixer	5 년 전
sphinx-known-warnings.txt	9295e54c9d docs: Adds secure_boot_v2 for ESP32-C3 ECO3	4 년 전

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.

README.md

Documentation Source Folder

Hosted Documentation

Building Documentation