Startsida Utforska Hjälp
Logga in
RT-Thread-packages
/
esp-idf
spegling av https://github-proxy.rt-thread.io/RT-Thread-packages/esp-idf.git
2
0
Fork 0
Filer Ärenden 0 Wiki
Träd: e4dd9053c2
Grenar Taggar
esp-idf
/
docs
Angus Gratton e4dd9053c2 Merge branch 'feature/secure_bootv2_c3_v4.3' into 'release/v4.3' 4 år sedan
..
_static b639514793 touch_element: add touch element api-reference doc 4 år sedan
doxygen d42958439d Merge branch 'doc/c3_api_ref_update_v4.3' into 'release/v4.3' 4 år sedan
en e4dd9053c2 Merge branch 'feature/secure_bootv2_c3_v4.3' into 'release/v4.3' 4 år sedan
extensions 0146f258d7 style: format python files with isort and double-quote-string-fixer 5 år sedan
idf_extensions 548fd02d10 docs: initial update of programming guide for C3 5 år sedan
latex_templates 66fb5a29bb Whitespace: Automated whitespace fixes (large commit) 5 år sedan
test 548fd02d10 docs: initial update of programming guide for C3 5 år sedan
zh_CN 76ff1724b3 Merge branch 'feature/remove_hspi_macor_on_chips_later_than_s2_v4.3' into 'release/v4.3' 4 år sedan
README.md 416076665b docs: use new sphinx_idf_theme theme, add variables to allow theme to build version footer 5 år sedan
TEMPLATE_EXAMPLE_README.md de682a13b1 examples: Update system examples README 6 år sedan
build_docs.py 548fd02d10 docs: initial update of programming guide for C3 5 år sedan
check_lang_folder_sync.sh e94288da31 global: use '/usr/bin/env bash' instead of '/usr/bin/bash' in shebangs 5 år sedan
conf_common.py c9087c205b docs: updated system api-reference chapters for C3 4 år sedan
doxygen-known-warnings.txt 11fac8637a docs: Resolve doxygen & Sphinx warnings 6 år sedan
generate_chart.py 0146f258d7 style: format python files with isort and double-quote-string-fixer 5 år sedan
get_github_rev.py 214f1fbbed docs: add 'edit-on-github' link to html theme 5 år sedan
page_redirects.txt 962ea8b9f2 docs: repurpose WROVER-KIT debugging guide for Kaluga-1 5 år sedan
requirements.txt 88aa3c2463 docs: bump cairosvg from 2.4.2 to 2.5.1 in /docs 5 år sedan
sanitize_version.py 0146f258d7 style: format python files with isort and double-quote-string-fixer 5 år sedan
sphinx-known-warnings.txt 19b90e8ba9 docs: Adds secure_boot_v2 for ESP32-C3 ECO3 4 år sedan

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.