Domů Procházet Nápověda
Přihlásit se
RT-Thread-packages
/
esp-idf
zrcadlo https://github-proxy.rt-thread.io/RT-Thread-packages/esp-idf.git
2
0
Rozštěpit 0
Soubory Úkoly 0 Wiki
Strom: aa33c43644
Větve Značky
esp-idf
/
docs
Angus Gratton 2b19bd0c2f Merge branch 'doc/timer_group_update_for_esp32c3' into 'release/v4.3' před 4 roky
..
_static 5fa34f6a30 Merge branch 'docs/add_esp32-c3-devkitc-02_user_guide' into 'release/v4.3' před 4 roky
doxygen 97df333a3b docs: fix doxygen compile warnings for doxygen 1.9.1 před 4 roky
en 2b19bd0c2f Merge branch 'doc/timer_group_update_for_esp32c3' into 'release/v4.3' před 4 roky
extensions 0146f258d7 style: format python files with isort and double-quote-string-fixer před 5 roky
idf_extensions 626964beae docs: add C3 TRM links před 4 roky
latex_templates 66fb5a29bb Whitespace: Automated whitespace fixes (large commit) před 5 roky
test 548fd02d10 docs: initial update of programming guide for C3 před 5 roky
zh_CN 2b19bd0c2f Merge branch 'doc/timer_group_update_for_esp32c3' into 'release/v4.3' před 4 roky
README.md 416076665b docs: use new sphinx_idf_theme theme, add variables to allow theme to build version footer před 5 roky
TEMPLATE_EXAMPLE_README.md de682a13b1 examples: Update system examples README před 6 roky
build_docs.py 548fd02d10 docs: initial update of programming guide for C3 před 5 roky
check_lang_folder_sync.sh e94288da31 global: use '/usr/bin/env bash' instead of '/usr/bin/bash' in shebangs před 5 roky
conf_common.py 50e3f9f66c docs: Update JTAG debugging guides for ESP32-C3 před 4 roky
doxygen-known-warnings.txt 11fac8637a docs: Resolve doxygen & Sphinx warnings před 6 roky
generate_chart.py 0146f258d7 style: format python files with isort and double-quote-string-fixer před 5 roky
get_github_rev.py 214f1fbbed docs: add 'edit-on-github' link to html theme před 5 roky
page_redirects.txt 962ea8b9f2 docs: repurpose WROVER-KIT debugging guide for Kaluga-1 před 5 roky
requirements.txt 88aa3c2463 docs: bump cairosvg from 2.4.2 to 2.5.1 in /docs před 5 roky
sanitize_version.py 0146f258d7 style: format python files with isort and double-quote-string-fixer před 5 roky
sphinx-known-warnings.txt 19b90e8ba9 docs: Adds secure_boot_v2 for ESP32-C3 ECO3 před 4 roky

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.