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: ef2a871e2c
Branches Tags
esp-idf
/
docs
Jakob Hasse 1c3be690ed [esp_hw_support]: HMAC upstream support for S3 il y a 4 ans
..
_static baebf74342 docs/add_esp32-s2-devkitc-1_user_guide il y a 4 ans
doxygen 1c3be690ed [esp_hw_support]: HMAC upstream support for S3 il y a 4 ans
en d4bd603745 Merge branch 'docs/frameworks_and_libs_update' into 'master' il y a 4 ans
extensions 50fe1eea15 doc: Add support for redirects to external URL il y a 4 ans
idf_extensions 42e303a6f9 docs: add S3 TRM URL il y a 4 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 d4bd603745 Merge branch 'docs/frameworks_and_libs_update' into 'master' il y a 4 ans
README.md 416076665b docs: use new sphinx_idf_theme theme, add variables to allow theme to build version footer il y a 5 ans
TEMPLATE_EXAMPLE_README.md de682a13b1 examples: Update system examples README il y a 6 ans
build_docs.py bdfda351bd build docs: enable building of S3 docs il y a 4 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 1c3be690ed [esp_hw_support]: HMAC upstream support for S3 il y a 4 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 2218204aa7 doc: update tinyusb document to support esp32s3 il y a 4 ans
requirements.txt e8b7d2ca08 docs: add warning for outdated versions il y a 4 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 e07be3df49 docs: ignore duplicate def warning in BT docs il y a 4 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.