Почетна Преглед Помоћ
Пријавите се
RT-Thread-packages
/
esp-idf
огледало од https://github-proxy.rt-thread.io/RT-Thread-packages/esp-idf.git
2
0
Креирај огранак 0
Датотеке Дискусије 0 Вики
Дрво: b302b4bb43
Гране Ознаке
esp-idf
/
docs
Kirill Chalov 2e5f983b5a Add user guides for ESP32-S2-Kaluga-1-Kit пре 5 година
..
_static bc397f8b7d Add new section about using ESP-IDF with PlatformIO пре 5 година
en 2e5f983b5a Add user guides for ESP32-S2-Kaluga-1-Kit пре 5 година
extensions 63b76a9d90 doc: custom list filter directive пре 6 година
idf_extensions dc2c753a7d doc: remove links to translation if building PDF пре 5 година
latex_templates 407275f681 doc: add latex and PDF generation to build_docs пре 5 година
zh_CN 2e5f983b5a Add user guides for ESP32-S2-Kaluga-1-Kit пре 5 година
Doxyfile 2da7e65646 Doc: S2 HMAC documentation пре 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 407275f681 doc: add latex and PDF generation to build_docs пре 5 година
check_lang_folder_sync.sh e94288da31 global: use '/usr/bin/env bash' instead of '/usr/bin/bash' in shebangs пре 5 година
conf_common.py ab9f714248 Add build system support for programming ESP32-S2 using DFU utils пре 5 година
doxygen-known-warnings.txt 11fac8637a docs: Resolve doxygen & Sphinx warnings пре 6 година
page_redirects.txt 3dec957bc8 doc: Create redirects for ESP32 hw-reference get-started URLs пре 5 година
requirements.txt 8a3d806798 doc: update CI to build PDF пре 5 година
sanitize_version.py 1a2ddcb77a docs: deploy docs to production server from CI пре 6 година
sphinx-known-warnings.txt 11fac8637a docs: Resolve doxygen & Sphinx warnings пре 6 година

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.