Acasă Explorează Ajutor
Autentificare
RT-Thread-packages
/
esp-idf
oglindă de https://github-proxy.rt-thread.io/RT-Thread-packages/esp-idf.git
2
0
Bifurcare 0
Fisiere Probleme 0 Wiki
Arbore: c1b3d77dcf
Ramuri Etichete
esp-idf
/
docs
Krzysztof Budzynski c07f21a467 Merge branch 'doc/remove_modules_and_boards_section_from_hw_reference' into 'master' 4 ani în urmă
..
_static 997170ede1 Merge branch 'docs/introduce_new_rules_for_updating_docs' into 'master' 4 ani în urmă
doxygen e14edecf5f docs: Add random number generation to the API Reference System section 4 ani în urmă
en c07f21a467 Merge branch 'doc/remove_modules_and_boards_section_from_hw_reference' into 'master' 4 ani în urmă
extensions 50fe1eea15 doc: Add support for redirects to external URL 4 ani în urmă
idf_extensions 41b3043cb4 Add warning to docs output if fastbuild 4 ani în urmă
latex_templates 66fb5a29bb Whitespace: Automated whitespace fixes (large commit) 5 ani în urmă
test 548fd02d10 docs: initial update of programming guide for C3 5 ani în urmă
zh_CN c07f21a467 Merge branch 'doc/remove_modules_and_boards_section_from_hw_reference' into 'master' 4 ani în urmă
README.md 416076665b docs: use new sphinx_idf_theme theme, add variables to allow theme to build version footer 5 ani în urmă
TEMPLATE_EXAMPLE_README.md de682a13b1 examples: Update system examples README 6 ani în urmă
build_docs.py 89179dc286 docs: add fast build feature and activate it in CI 4 ani în urmă
check_lang_folder_sync.sh e94288da31 global: use '/usr/bin/env bash' instead of '/usr/bin/bash' in shebangs 5 ani în urmă
conf_common.py 0c17973d54 docs: add rf calibration docs for S2 and C3 4 ani în urmă
doxygen-known-warnings.txt 11fac8637a docs: Resolve doxygen & Sphinx warnings 6 ani în urmă
generate_chart.py 0146f258d7 style: format python files with isort and double-quote-string-fixer 5 ani în urmă
get_github_rev.py 214f1fbbed docs: add 'edit-on-github' link to html theme 5 ani în urmă
page_redirects.txt c07f21a467 Merge branch 'doc/remove_modules_and_boards_section_from_hw_reference' into 'master' 4 ani în urmă
requirements.txt e8b7d2ca08 docs: add warning for outdated versions 4 ani în urmă
sanitize_version.py 0146f258d7 style: format python files with isort and double-quote-string-fixer 5 ani în urmă
sphinx-known-warnings.txt 9295e54c9d docs: Adds secure_boot_v2 for ESP32-C3 ECO3 4 ani în urmă

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.