Почетна Преглед Помоћ
Пријавите се
RT-Thread-packages
/
esp-idf
огледало од https://github-proxy.rt-thread.io/RT-Thread-packages/esp-idf.git
2
0
Креирај огранак 0
Датотеке Дискусије 0 Вики
Дрво: f925da9179
Гране Ознаке
esp-idf
/
docs
Darian Leung 97721d469c TWAI: Add ESP32-S2 support пре 5 година
..
_static 97721d469c TWAI: Add ESP32-S2 support пре 5 година
en 97721d469c TWAI: Add ESP32-S2 support пре 5 година
extensions 63b76a9d90 doc: custom list filter directive пре 6 година
idf_extensions 32761b9782 docs: fix link_roles not linking correctly for certain files пре 5 година
latex_templates 407275f681 doc: add latex and PDF generation to build_docs пре 5 година
zh_CN 97721d469c TWAI: Add ESP32-S2 support пре 5 година
Doxyfile 97721d469c TWAI: Add ESP32-S2 support пре 5 година
README.md 416076665b docs: use new sphinx_idf_theme theme, add variables to allow theme to build version footer пре 5 година
TEMPLATE_EXAMPLE_README.md de682a13b1 examples: Update system examples README пре 6 година
build_docs.py 67ea59d605 docs: fix check_docs not working for multiple builders пре 5 година
check_lang_folder_sync.sh e94288da31 global: use '/usr/bin/env bash' instead of '/usr/bin/bash' in shebangs пре 5 година
conf_common.py 5985c07ab7 docs: add section about USB CDC console пре 5 година
doxygen-known-warnings.txt 11fac8637a docs: Resolve doxygen & Sphinx warnings пре 6 година
get_github_rev.py 214f1fbbed docs: add 'edit-on-github' link to html theme пре 5 година
page_redirects.txt 97721d469c TWAI: Add ESP32-S2 support пре 5 година
requirements.txt 8a3d806798 doc: update CI to build PDF пре 5 година
sanitize_version.py 1a2ddcb77a docs: deploy docs to production server from CI пре 5 година
sphinx-known-warnings.txt 67ea59d605 docs: fix check_docs not working for multiple builders пре 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.