Почетна Преглед Помоћ
Пријавите се
RT-Thread-packages
/
esp-idf
огледало од https://github-proxy.rt-thread.io/RT-Thread-packages/esp-idf.git
2
0
Креирај огранак 0
Датотеке Дискусије 0 Вики
Дрво: a4f263948c
Гране Ознаке
esp-idf
/
docs
Angus Gratton dc6b950257 doc: Add performance guides for execuion speed, binary size, RAM usage пре 5 година
..
_static 997170ede1 Merge branch 'docs/introduce_new_rules_for_updating_docs' into 'master' пре 4 година
doxygen e14edecf5f docs: Add random number generation to the API Reference System section пре 4 година
en dc6b950257 doc: Add performance guides for execuion speed, binary size, RAM usage пре 4 година
extensions 50fe1eea15 doc: Add support for redirects to external URL пре 4 година
idf_extensions 41b3043cb4 Add warning to docs output if fastbuild пре 4 година
latex_templates 66fb5a29bb Whitespace: Automated whitespace fixes (large commit) пре 5 година
test 548fd02d10 docs: initial update of programming guide for C3 пре 5 година
zh_CN dc6b950257 doc: Add performance guides for execuion speed, binary size, RAM usage пре 4 година
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 89179dc286 docs: add fast build feature and activate it in CI пре 4 година
check_lang_folder_sync.sh e94288da31 global: use '/usr/bin/env bash' instead of '/usr/bin/bash' in shebangs пре 5 година
conf_common.py 0c17973d54 docs: add rf calibration docs for S2 and C3 пре 4 година
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 пре 5 година
page_redirects.txt c07f21a467 Merge branch 'doc/remove_modules_and_boards_section_from_hw_reference' into 'master' пре 4 година
requirements.txt e8b7d2ca08 docs: add warning for outdated versions пре 4 година
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 пре 4 година

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.