ホーム エクスプローラ ヘルプ
サインイン
RT-Thread-packages
/
esp-idf
同期ミラー https://github-proxy.rt-thread.io/RT-Thread-packages/esp-idf.git
2
0
フォーク 0
ファイル 課題 0 Wiki
ツリー: d61ee580d5
ブランチ タグ
esp-idf
/
docs
Michael (XIAO Xufeng) 24f3341a2d Merge branch 'docs/spi_flash_auto_suspend_v4.3' into 'release/v4.3' 5 年 前
..
_static aa2b3e1b01 Add ESP32-C3-DevKitM-1 User Guide and updated ESP32C3_DOCS 5 年 前
doxygen 548fd02d10 docs: initial update of programming guide for C3 5 年 前
en 24f3341a2d Merge branch 'docs/spi_flash_auto_suspend_v4.3' into 'release/v4.3' 5 年 前
extensions 0146f258d7 style: format python files with isort and double-quote-string-fixer 5 年 前
idf_extensions 548fd02d10 docs: initial update of programming guide for C3 5 年 前
latex_templates 66fb5a29bb Whitespace: Automated whitespace fixes (large commit) 5 年 前
test 548fd02d10 docs: initial update of programming guide for C3 5 年 前
zh_CN 24f3341a2d Merge branch 'docs/spi_flash_auto_suspend_v4.3' into 'release/v4.3' 5 年 前
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 aa2b3e1b01 Add ESP32-C3-DevKitM-1 User Guide and updated ESP32C3_DOCS 5 年 前
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 88aa3c2463 docs: bump cairosvg from 2.4.2 to 2.5.1 in /docs 5 年 前
sanitize_version.py 0146f258d7 style: format python files with isort and double-quote-string-fixer 5 年 前
sphinx-known-warnings.txt 548fd02d10 docs: initial update of programming guide for C3 5 年 前

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.