Acasă Explorează Ajutor
Autentificare
RT-Thread-packages
/
esp-idf
oglindă de https://github-proxy.rt-thread.io/RT-Thread-packages/esp-idf.git
2
0
Bifurcare 0
Fisiere Probleme 0 Wiki
Arbore: fa995fd92f
Ramuri Etichete
esp-idf
/
docs
Michael (XIAO Xufeng) 78090d24e4 Merge branch 'bugfix/flash_suspend_restriction' into 'master' 4 ani în urmă
..
_static 424fe73a23 Add ESP32-C3-DevKitC-02 User Guide 4 ani în urmă
doxygen 6334b5e56f docs: update api-reference chapters for C3 5 ani în urmă
en 78090d24e4 Merge branch 'bugfix/flash_suspend_restriction' into 'master' 4 ani în urmă
extensions 0146f258d7 style: format python files with isort and double-quote-string-fixer 5 ani în urmă
idf_extensions 548fd02d10 docs: initial update of programming guide for C3 5 ani în urmă
latex_templates 66fb5a29bb Whitespace: Automated whitespace fixes (large commit) 5 ani în urmă
test 548fd02d10 docs: initial update of programming guide for C3 5 ani în urmă
zh_CN 78090d24e4 Merge branch 'bugfix/flash_suspend_restriction' into 'master' 4 ani în urmă
README.md 416076665b docs: use new sphinx_idf_theme theme, add variables to allow theme to build version footer 6 ani în urmă
TEMPLATE_EXAMPLE_README.md de682a13b1 examples: Update system examples README 6 ani în urmă
build_docs.py 548fd02d10 docs: initial update of programming guide for C3 5 ani în urmă
check_lang_folder_sync.sh e94288da31 global: use '/usr/bin/env bash' instead of '/usr/bin/bash' in shebangs 5 ani în urmă
conf_common.py 91439e3818 docs: updated system api-reference chapters for C3 4 ani în urmă
doxygen-known-warnings.txt 11fac8637a docs: Resolve doxygen & Sphinx warnings 6 ani în urmă
generate_chart.py 0146f258d7 style: format python files with isort and double-quote-string-fixer 5 ani în urmă
get_github_rev.py 214f1fbbed docs: add 'edit-on-github' link to html theme 5 ani în urmă
page_redirects.txt 962ea8b9f2 docs: repurpose WROVER-KIT debugging guide for Kaluga-1 5 ani în urmă
requirements.txt 4e9d810dfb Docs: build doc with new layout for target and version select 5 ani în urmă
sanitize_version.py 0146f258d7 style: format python files with isort and double-quote-string-fixer 5 ani în urmă
sphinx-known-warnings.txt 548fd02d10 docs: initial update of programming guide for C3 5 ani în urmă

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.