Почетна Преглед Помоћ
Пријавите се
RT-Thread-packages
/
esp-idf
огледало од https://github-proxy.rt-thread.io/RT-Thread-packages/esp-idf.git
2
0
Креирај огранак 0
Датотеке Дискусије 0 Вики
Дрво: fa995fd92f
Гране Ознаке
esp-idf
/
docs
Michael (XIAO Xufeng) 78090d24e4 Merge branch 'bugfix/flash_suspend_restriction' into 'master' пре 4 година
..
_static 424fe73a23 Add ESP32-C3-DevKitC-02 User Guide пре 4 година
doxygen 6334b5e56f docs: update api-reference chapters for C3 пре 5 година
en 78090d24e4 Merge branch 'bugfix/flash_suspend_restriction' into 'master' пре 4 година
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 78090d24e4 Merge branch 'bugfix/flash_suspend_restriction' into 'master' пре 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 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 91439e3818 docs: updated system api-reference chapters for 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 пре 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.