Halaman utama Jelajahi Bantuan
Masuk
RT-Thread-packages
/
esp-idf
cermin dari https://github-proxy.rt-thread.io/RT-Thread-packages/esp-idf.git
2
0
Fork 0
Berkas Masalah 0 Wiki
Pohon: 28fd413bf5
Ranting Tag
esp-idf
/
docs
Angus Gratton f7a8593a3b Merge branch 'style/python_isort_double_quote_fixer' into 'master' 5 tahun lalu
..
_static 5ca85248e3 Merge branch 'docs/update_docs_based_on_several_customer_feedbacks' into 'master' 5 tahun lalu
doxygen 7c1c669799 component/bt: add BLE v5.0 feature for bluedroid host 5 tahun lalu
en 9a5bd86d54 Merge branch 'docs/update_docs_based_on_the_second_batch_of_customer_feedbacks' into 'master' 5 tahun lalu
extensions 0146f258d7 style: format python files with isort and double-quote-string-fixer 5 tahun lalu
idf_extensions 0146f258d7 style: format python files with isort and double-quote-string-fixer 5 tahun lalu
latex_templates 66fb5a29bb Whitespace: Automated whitespace fixes (large commit) 5 tahun lalu
test 0146f258d7 style: format python files with isort and double-quote-string-fixer 5 tahun lalu
zh_CN 1faff89ff6 Merge branch 'feature/update_jtag_translation' into 'master' 5 tahun lalu
README.md 416076665b docs: use new sphinx_idf_theme theme, add variables to allow theme to build version footer 5 tahun lalu
TEMPLATE_EXAMPLE_README.md de682a13b1 examples: Update system examples README 6 tahun lalu
build_docs.py 0146f258d7 style: format python files with isort and double-quote-string-fixer 5 tahun lalu
check_lang_folder_sync.sh e94288da31 global: use '/usr/bin/env bash' instead of '/usr/bin/bash' in shebangs 5 tahun lalu
conf_common.py f634c59289 Add hypertargets to all TRM references 5 tahun lalu
doxygen-known-warnings.txt 11fac8637a docs: Resolve doxygen & Sphinx warnings 6 tahun lalu
generate_chart.py 0146f258d7 style: format python files with isort and double-quote-string-fixer 5 tahun lalu
get_github_rev.py 214f1fbbed docs: add 'edit-on-github' link to html theme 5 tahun lalu
page_redirects.txt 962ea8b9f2 docs: repurpose WROVER-KIT debugging guide for Kaluga-1 5 tahun lalu
requirements.txt 88aa3c2463 docs: bump cairosvg from 2.4.2 to 2.5.1 in /docs 5 tahun lalu
sanitize_version.py 0146f258d7 style: format python files with isort and double-quote-string-fixer 5 tahun lalu
sphinx-known-warnings.txt b6dba84323 ulp: added support to building code for riscv ULP coprocessor 5 tahun lalu

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.