صفحهٔ اصلی گشت‌و‌گذار راهنما
ورود
RT-Thread-packages
/
esp-idf
mirrorاز https://github-proxy.rt-thread.io/RT-Thread-packages/esp-idf.git
2
0
انشعاب 0
پرونده‌ها مشکلات 0 ویکی
درخت: a09e413fb6
شاخه‌ها تگ‌ها
esp-idf
/
docs
morris d4fe219c49 mcpwm: refactor driver 5 سال پیش
..
_static 997170ede1 Merge branch 'docs/introduce_new_rules_for_updating_docs' into 'master' 5 سال پیش
doxygen bdfda351bd build docs: enable building of S3 docs 5 سال پیش
en d4fe219c49 mcpwm: refactor driver 5 سال پیش
extensions 50fe1eea15 doc: Add support for redirects to external URL 5 سال پیش
idf_extensions bdfda351bd build docs: enable building of S3 docs 5 سال پیش
latex_templates 66fb5a29bb Whitespace: Automated whitespace fixes (large commit) 5 سال پیش
test 548fd02d10 docs: initial update of programming guide for C3 5 سال پیش
zh_CN fbd6e9e320 docs: remove duplicate label 5 سال پیش
README.md 416076665b docs: use new sphinx_idf_theme theme, add variables to allow theme to build version footer 6 سال پیش
TEMPLATE_EXAMPLE_README.md de682a13b1 examples: Update system examples README 6 سال پیش
build_docs.py bdfda351bd build docs: enable building of S3 docs 5 سال پیش
check_lang_folder_sync.sh e94288da31 global: use '/usr/bin/env bash' instead of '/usr/bin/bash' in shebangs 6 سال پیش
conf_common.py bdfda351bd build docs: enable building of S3 docs 5 سال پیش
doxygen-known-warnings.txt 11fac8637a docs: Resolve doxygen & Sphinx warnings 6 سال پیش
generate_chart.py 0146f258d7 style: format python files with isort and double-quote-string-fixer 5 سال پیش
get_github_rev.py 214f1fbbed docs: add 'edit-on-github' link to html theme 6 سال پیش
page_redirects.txt c07f21a467 Merge branch 'doc/remove_modules_and_boards_section_from_hw_reference' into 'master' 5 سال پیش
requirements.txt e8b7d2ca08 docs: add warning for outdated versions 5 سال پیش
sanitize_version.py 0146f258d7 style: format python files with isort and double-quote-string-fixer 5 سال پیش
sphinx-known-warnings.txt 9295e54c9d docs: Adds secure_boot_v2 for ESP32-C3 ECO3 5 سال پیش

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.