Home Explore Help
Sign In
RT-Thread-packages
/
esp-idf
mirror of https://github-proxy.rt-thread.io/RT-Thread-packages/esp-idf.git
2
0
Fork 0
Files Issues 0 Wiki
Tree: 3a9a208edc
Branches Tags
esp-idf
/
docs
Ondrej Kosta d6b1a9909f Merge branch 'docfix/eth_events_4.3' into 'release/v4.3' 4 years ago
..
_static 4cf9aecfe9 docs/add_esp32-s2-devkitc-1_user_guide 4 years ago
doxygen 00b9df2937 Add support of NimBLE host to Blufi 4 years ago
en d6b1a9909f Merge branch 'docfix/eth_events_4.3' into 'release/v4.3' 4 years ago
extensions 0146f258d7 style: format python files with isort and double-quote-string-fixer 5 years ago
idf_extensions 626964beae docs: add C3 TRM links 4 years ago
latex_templates 66fb5a29bb Whitespace: Automated whitespace fixes (large commit) 5 years ago
test 548fd02d10 docs: initial update of programming guide for C3 5 years ago
zh_CN 4cf9aecfe9 docs/add_esp32-s2-devkitc-1_user_guide 4 years ago
README.md 416076665b docs: use new sphinx_idf_theme theme, add variables to allow theme to build version footer 5 years ago
TEMPLATE_EXAMPLE_README.md de682a13b1 examples: Update system examples README 6 years ago
build_docs.py 548fd02d10 docs: initial update of programming guide for C3 5 years ago
check_lang_folder_sync.sh e94288da31 global: use '/usr/bin/env bash' instead of '/usr/bin/bash' in shebangs 5 years ago
conf_common.py 8744cb880b docs: add rf calibration docs for S2 and C3 4 years ago
doxygen-known-warnings.txt 11fac8637a docs: Resolve doxygen & Sphinx warnings 6 years ago
generate_chart.py 0146f258d7 style: format python files with isort and double-quote-string-fixer 5 years ago
get_github_rev.py 214f1fbbed docs: add 'edit-on-github' link to html theme 5 years ago
page_redirects.txt 962ea8b9f2 docs: repurpose WROVER-KIT debugging guide for Kaluga-1 5 years ago
requirements.txt 88aa3c2463 docs: bump cairosvg from 2.4.2 to 2.5.1 in /docs 5 years ago
sanitize_version.py 0146f258d7 style: format python files with isort and double-quote-string-fixer 5 years ago
sphinx-known-warnings.txt 00b9df2937 Add support of NimBLE host to Blufi 4 years ago

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.