Sākums Izpētīt Palīdzība
Pierakstīties
RT-Thread-packages
/
esp-idf
spogulis no https://github-proxy.rt-thread.io/RT-Thread-packages/esp-idf.git
2
0
Atdalīts 0
Faili Problēmas 0 Vikivietne
Koks: e81facd3e8
Atzari Tagi
esp-idf
/
docs
morris 3e2d98500f Merge branch 'refactor/common_rom_rtc_apis' into 'master' 4 gadi atpakaļ
..
_static e95893bb1b docs: rename ESP-MESH to ESP-WIFI-MESH 4 gadi atpakaļ
doxygen 59b49d2783 Merge branch 'feature/add-nimble-host-to-blufi' into 'master' 4 gadi atpakaļ
en 3e2d98500f Merge branch 'refactor/common_rom_rtc_apis' into 'master' 4 gadi atpakaļ
extensions 50fe1eea15 doc: Add support for redirects to external URL 4 gadi atpakaļ
idf_extensions 42e303a6f9 docs: add S3 TRM URL 4 gadi atpakaļ
latex_templates 66fb5a29bb Whitespace: Automated whitespace fixes (large commit) 5 gadi atpakaļ
test 548fd02d10 docs: initial update of programming guide for C3 5 gadi atpakaļ
zh_CN 1560d6f1ba soc: add reset reasons in soc component 4 gadi atpakaļ
README.md 416076665b docs: use new sphinx_idf_theme theme, add variables to allow theme to build version footer 5 gadi atpakaļ
TEMPLATE_EXAMPLE_README.md de682a13b1 examples: Update system examples README 6 gadi atpakaļ
build_docs.py bdfda351bd build docs: enable building of S3 docs 4 gadi atpakaļ
check_lang_folder_sync.sh e94288da31 global: use '/usr/bin/env bash' instead of '/usr/bin/bash' in shebangs 5 gadi atpakaļ
conf_common.py faee145a61 docs:add esp32-s3-devkitc-1 user guide 4 gadi atpakaļ
doxygen-known-warnings.txt 11fac8637a docs: Resolve doxygen & Sphinx warnings 6 gadi atpakaļ
generate_chart.py 0146f258d7 style: format python files with isort and double-quote-string-fixer 5 gadi atpakaļ
get_github_rev.py 214f1fbbed docs: add 'edit-on-github' link to html theme 5 gadi atpakaļ
page_redirects.txt e95893bb1b docs: rename ESP-MESH to ESP-WIFI-MESH 4 gadi atpakaļ
requirements.txt e8b7d2ca08 docs: add warning for outdated versions 4 gadi atpakaļ
sanitize_version.py 0146f258d7 style: format python files with isort and double-quote-string-fixer 5 gadi atpakaļ
sphinx-known-warnings.txt e07be3df49 docs: ignore duplicate def warning in BT docs 4 gadi atpakaļ

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.