Accueil Explorer Aide
Connexion
RT-Thread-packages
/
esp-idf
miroir de https://github-proxy.rt-thread.io/RT-Thread-packages/esp-idf.git
2
0
Fork 0
Fichiers Tickets 0 Wiki
Aborescence: e29b99f1a5
Branches Tags
esp-idf
/
docs
Michael (XIAO Xufeng) 268289eade Merge branch 'docs/spi_flash_auto_suspend' into 'master' il y a 5 ans
..
_static 78a1cd3643 touch_element: add touch element api-reference doc il y a 5 ans
doxygen 813044c6db docs, ci: update docs and ci with movements from esp_common il y a 5 ans
en 268289eade Merge branch 'docs/spi_flash_auto_suspend' into 'master' il y a 5 ans
extensions 0146f258d7 style: format python files with isort and double-quote-string-fixer il y a 5 ans
idf_extensions 548fd02d10 docs: initial update of programming guide for C3 il y a 5 ans
latex_templates 66fb5a29bb Whitespace: Automated whitespace fixes (large commit) il y a 5 ans
test 548fd02d10 docs: initial update of programming guide for C3 il y a 5 ans
zh_CN 268289eade Merge branch 'docs/spi_flash_auto_suspend' into 'master' il y a 5 ans
README.md 416076665b docs: use new sphinx_idf_theme theme, add variables to allow theme to build version footer il y a 6 ans
TEMPLATE_EXAMPLE_README.md de682a13b1 examples: Update system examples README il y a 6 ans
build_docs.py 548fd02d10 docs: initial update of programming guide for C3 il y a 5 ans
check_lang_folder_sync.sh e94288da31 global: use '/usr/bin/env bash' instead of '/usr/bin/bash' in shebangs il y a 5 ans
conf_common.py 78a1cd3643 touch_element: add touch element api-reference doc il y a 5 ans
doxygen-known-warnings.txt 11fac8637a docs: Resolve doxygen & Sphinx warnings il y a 6 ans
generate_chart.py 0146f258d7 style: format python files with isort and double-quote-string-fixer il y a 5 ans
get_github_rev.py 214f1fbbed docs: add 'edit-on-github' link to html theme il y a 5 ans
page_redirects.txt 962ea8b9f2 docs: repurpose WROVER-KIT debugging guide for Kaluga-1 il y a 5 ans
requirements.txt 88aa3c2463 docs: bump cairosvg from 2.4.2 to 2.5.1 in /docs il y a 5 ans
sanitize_version.py 0146f258d7 style: format python files with isort and double-quote-string-fixer il y a 5 ans
sphinx-known-warnings.txt 548fd02d10 docs: initial update of programming guide for C3 il y a 5 ans

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.