Home Esplora Aiuto
Accedi
RT-Thread-packages
/
esp-idf
mirror da https://github-proxy.rt-thread.io/RT-Thread-packages/esp-idf.git
2
0
Forka 0
File Problemi 0 Wiki
Albero (Tree): 0a395134d4
Rami (Branch) Tag
esp-idf
/
docs
Krzysztof Budzynski d14661eaa3 Merge branch 'docs/programming_guide_c3_update_twai' into 'master' 4 anni fa
..
_static 424fe73a23 Add ESP32-C3-DevKitC-02 User Guide 4 anni fa
doxygen 0633ee3e18 docs: fix doxygen compile warnings for doxygen 1.9.1 4 anni fa
en d14661eaa3 Merge branch 'docs/programming_guide_c3_update_twai' into 'master' 4 anni fa
extensions 440fab3d6e docs: add google analytics tracking 4 anni fa
idf_extensions 1ff2c834ce docs: add C3 TRM links 4 anni fa
latex_templates 66fb5a29bb Whitespace: Automated whitespace fixes (large commit) 5 anni fa
test 548fd02d10 docs: initial update of programming guide for C3 5 anni fa
zh_CN bf49917233 Merge branch 'doc/macos_ftdi_jtag' into 'master' 4 anni fa
README.md 416076665b docs: use new sphinx_idf_theme theme, add variables to allow theme to build version footer 5 anni fa
TEMPLATE_EXAMPLE_README.md de682a13b1 examples: Update system examples README 6 anni fa
build_docs.py 548fd02d10 docs: initial update of programming guide for C3 5 anni fa
check_lang_folder_sync.sh e94288da31 global: use '/usr/bin/env bash' instead of '/usr/bin/bash' in shebangs 5 anni fa
conf_common.py 75dfd970b4 dac: added DAC support macro 4 anni fa
doxygen-known-warnings.txt 11fac8637a docs: Resolve doxygen & Sphinx warnings 6 anni fa
generate_chart.py 0146f258d7 style: format python files with isort and double-quote-string-fixer 5 anni fa
get_github_rev.py 214f1fbbed docs: add 'edit-on-github' link to html theme 5 anni fa
page_redirects.txt 962ea8b9f2 docs: repurpose WROVER-KIT debugging guide for Kaluga-1 5 anni fa
requirements.txt 4e9d810dfb Docs: build doc with new layout for target and version select 4 anni fa
sanitize_version.py 0146f258d7 style: format python files with isort and double-quote-string-fixer 5 anni fa
sphinx-known-warnings.txt 9295e54c9d docs: Adds secure_boot_v2 for ESP32-C3 ECO3 4 anni fa

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.