ホーム エクスプローラ ヘルプ
サインイン
RT-Thread-packages
/
esp-idf
同期ミラー https://github-proxy.rt-thread.io/RT-Thread-packages/esp-idf.git
2
0
フォーク 0
ファイル 課題 0 Wiki
ツリー: fa62dfd5f9
ブランチ タグ
esp-idf
/
docs
Krzysztof Budzynski f4c56216e5 Merge branch 'doc/embed_example_v4.2' into 'release/v4.2' 5 年 前
..
_static e6db25af9d TWAI: Add ESP32-S2 support 5 年 前
en f4c56216e5 Merge branch 'doc/embed_example_v4.2' into 'release/v4.2' 5 年 前
extensions 63b76a9d90 doc: custom list filter directive 6 年 前
idf_extensions 2e469b52ae build system: Also get IDF version from annotated tags only 5 年 前
latex_templates 407275f681 doc: add latex and PDF generation to build_docs 6 年 前
zh_CN f4c56216e5 Merge branch 'doc/embed_example_v4.2' into 'release/v4.2' 5 年 前
Doxyfile 847a697c93 Driver(dac): fix DAC-DMA driver and unit test 5 年 前
README.md 416076665b docs: use new sphinx_idf_theme theme, add variables to allow theme to build version footer 6 年 前
TEMPLATE_EXAMPLE_README.md de682a13b1 examples: Update system examples README 6 年 前
build_docs.py dbdb1c1c23 docs: Update Versions file in line with the latest Support Policy document 5 年 前
check_lang_folder_sync.sh e94288da31 global: use '/usr/bin/env bash' instead of '/usr/bin/bash' in shebangs 6 年 前
conf_common.py 1f3d8588ae docs: ESP-IDF v4.2 fully supports ESP32-S2, remove documentation that describe preview support 5 年 前
doxygen-known-warnings.txt 11fac8637a docs: Resolve doxygen & Sphinx warnings 6 年 前
get_github_rev.py 214f1fbbed docs: add 'edit-on-github' link to html theme 5 年 前
page_redirects.txt ead33e155d docs: repurpose WROVER-KIT debugging guide for Kaluga-1 5 年 前
requirements.txt 61904135b3 docs: update sphinx_idf_theme documentation 5 年 前
sanitize_version.py 1a2ddcb77a docs: deploy docs to production server from CI 6 年 前
sphinx-known-warnings.txt 302a43562d docs: fix check_docs not working for multiple builders 5 年 前

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.