Strona główna Odkrywaj Pomoc
Zaloguj się
RT-Thread-packages
/
esp-idf
kopia lustrzana https://github-proxy.rt-thread.io/RT-Thread-packages/esp-idf.git
2
0
Forkuj 0
Pliki Problemy 0 Wiki
Drzewo: fe94de0310
Gałęzie Tagi
esp-idf
/
docs
Angus Gratton c49c915bcc Merge branch 'feature/allow_efuses_be_nested_in_efuse_table' into 'master' 4 lat temu
..
_static 997170ede1 Merge branch 'docs/introduce_new_rules_for_updating_docs' into 'master' 4 lat temu
doxygen e14edecf5f docs: Add random number generation to the API Reference System section 4 lat temu
en c49c915bcc Merge branch 'feature/allow_efuses_be_nested_in_efuse_table' into 'master' 4 lat temu
extensions 50fe1eea15 doc: Add support for redirects to external URL 4 lat temu
idf_extensions 41b3043cb4 Add warning to docs output if fastbuild 4 lat temu
latex_templates 66fb5a29bb Whitespace: Automated whitespace fixes (large commit) 5 lat temu
test 548fd02d10 docs: initial update of programming guide for C3 5 lat temu
zh_CN c7ead8cd73 docs: document contained an invalid character which couldnt be rendered in the PDF 4 lat temu
README.md 416076665b docs: use new sphinx_idf_theme theme, add variables to allow theme to build version footer 5 lat temu
TEMPLATE_EXAMPLE_README.md de682a13b1 examples: Update system examples README 6 lat temu
build_docs.py 89179dc286 docs: add fast build feature and activate it in CI 4 lat temu
check_lang_folder_sync.sh e94288da31 global: use '/usr/bin/env bash' instead of '/usr/bin/bash' in shebangs 5 lat temu
conf_common.py 0c17973d54 docs: add rf calibration docs for S2 and C3 4 lat temu
doxygen-known-warnings.txt 11fac8637a docs: Resolve doxygen & Sphinx warnings 6 lat temu
generate_chart.py 0146f258d7 style: format python files with isort and double-quote-string-fixer 5 lat temu
get_github_rev.py 214f1fbbed docs: add 'edit-on-github' link to html theme 5 lat temu
page_redirects.txt c07f21a467 Merge branch 'doc/remove_modules_and_boards_section_from_hw_reference' into 'master' 4 lat temu
requirements.txt e8b7d2ca08 docs: add warning for outdated versions 4 lat temu
sanitize_version.py 0146f258d7 style: format python files with isort and double-quote-string-fixer 5 lat temu
sphinx-known-warnings.txt 9295e54c9d docs: Adds secure_boot_v2 for ESP32-C3 ECO3 4 lat temu

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.