Etusivu Tutki Apua
Kirjaudu sisään
RT-Thread-packages
/
esp-idf
peilaus alkaen https://github-proxy.rt-thread.io/RT-Thread-packages/esp-idf.git
2
0
Haarauta 0
Tiedostot Esitykset 0 Wiki
Puu: v4.3.2
Haarat Tunnisteet
esp-idf
/
docs
Jiang Jiang Jian 55e415377d Merge branch 'docs/update_the_assignment_type_in_i2s_programming_example' into 'release/v4.3' 4 vuotta sitten
..
_static e1aaa31140 docs/update_two_esp32-c3_devkit_user_guides 4 vuotta sitten
doxygen 519f17f831 docs: define __DOXYGEN__ for doxygen builds 4 vuotta sitten
en 55e415377d Merge branch 'docs/update_the_assignment_type_in_i2s_programming_example' into 'release/v4.3' 4 vuotta sitten
extensions eeab4e4469 docs: add google analytics tracking 4 vuotta sitten
idf_extensions 626964beae docs: add C3 TRM links 4 vuotta sitten
latex_templates 66fb5a29bb Whitespace: Automated whitespace fixes (large commit) 5 vuotta sitten
test 548fd02d10 docs: initial update of programming guide for C3 5 vuotta sitten
zh_CN daf9cbbb01 Merge branch 'doc/make_classic_bt_API_ref_only_for_esp32_4.3' into 'release/v4.3' 4 vuotta sitten
README.md 416076665b docs: use new sphinx_idf_theme theme, add variables to allow theme to build version footer 5 vuotta sitten
TEMPLATE_EXAMPLE_README.md de682a13b1 examples: Update system examples README 6 vuotta sitten
build_docs.py 548fd02d10 docs: initial update of programming guide for C3 5 vuotta sitten
check_lang_folder_sync.sh e94288da31 global: use '/usr/bin/env bash' instead of '/usr/bin/bash' in shebangs 5 vuotta sitten
conf_common.py 58ff27cc03 Make Classic BT related document links only visible for ESP32 4 vuotta sitten
doxygen-known-warnings.txt 11fac8637a docs: Resolve doxygen & Sphinx warnings 6 vuotta sitten
generate_chart.py 0146f258d7 style: format python files with isort and double-quote-string-fixer 5 vuotta sitten
get_github_rev.py 214f1fbbed docs: add 'edit-on-github' link to html theme 5 vuotta sitten
page_redirects.txt 962ea8b9f2 docs: repurpose WROVER-KIT debugging guide for Kaluga-1 5 vuotta sitten
requirements.txt d13b69558a docs: add warning for outdated versions 4 vuotta sitten
sanitize_version.py 0146f258d7 style: format python files with isort and double-quote-string-fixer 5 vuotta sitten
sphinx-known-warnings.txt 00b9df2937 Add support of NimBLE host to Blufi 4 vuotta sitten

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.