ホーム エクスプローラ ヘルプ
サインイン
RT-Thread-packages
/
esp-idf
同期ミラー https://github-proxy.rt-thread.io/RT-Thread-packages/esp-idf.git
2
0
フォーク 0
ファイル 課題 0 Wiki
ツリー: 5ed53c272b
ブランチ タグ
esp-idf
/
docs
Zim Kalinowski f29d873c54 Merge branch 'feature/linenoise_improvement' into 'master' 4 年 前
..
_static e95893bb1b docs: rename ESP-MESH to ESP-WIFI-MESH 4 年 前
doxygen bdaeeb3169 ieee802154: add IEEE 802.15.4 component 4 年 前
en 0fd74a43c8 console: re-use the available REPL console API and improve linenoise 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 c01da712f6 docs: Move the bootloader size section into the Bootloader guide 4 年 前
README.md 416076665b docs: use new sphinx_idf_theme theme, add variables to allow theme to build version footer 6 年 前
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 6 年 前
conf_common.py faee145a61 docs:add esp32-s3-devkitc-1 user guide 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 e95893bb1b docs: rename ESP-MESH to ESP-WIFI-MESH 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.