Начало Каталог Помощ
Вход
RT-Thread-packages
/
esp-idf
огледало от https://github-proxy.rt-thread.io/RT-Thread-packages/esp-idf.git
2
0
Разклонения 0
Файлове Задачи 0 Уики
ИН на ревизия: 982d4be760
Клонове Маркери
esp-idf
/
docs
Angus Gratton 982d4be760 Merge branch 'bugfix/freertos_include_coreid' into 'master' преди 5 години
..
_static ba901179fe Update docs images преди 5 години
en 982d4be760 Merge branch 'bugfix/freertos_include_coreid' into 'master' преди 5 години
extensions 63b76a9d90 doc: custom list filter directive преди 6 години
idf_extensions 261363855c build system: Also get IDF version from annotated tags only преди 5 години
latex_templates 407275f681 doc: add latex and PDF generation to build_docs преди 5 години
test ba546a0d91 docs: Adds CI tests for the doc building process. преди 5 години
zh_CN 840efc2f54 docs: describe power management logic for ESP32-S2, fix translation преди 5 години
Doxyfile a3c90bf59a freertos: merged freertos 10 kernel files into IDF преди 5 години
README.md 416076665b docs: use new sphinx_idf_theme theme, add variables to allow theme to build version footer преди 5 години
TEMPLATE_EXAMPLE_README.md de682a13b1 examples: Update system examples README преди 6 години
build_docs.py 9b552ce004 docs: add warning for doxygen version преди 5 години
check_lang_folder_sync.sh e94288da31 global: use '/usr/bin/env bash' instead of '/usr/bin/bash' in shebangs преди 5 години
conf_common.py 7a9abe3ec5 add chart of version support to version.rst преди 5 години
doxygen-known-warnings.txt 11fac8637a docs: Resolve doxygen & Sphinx warnings преди 6 години
generate_chart.py 7a9abe3ec5 add chart of version support to version.rst преди 5 години
get_github_rev.py 214f1fbbed docs: add 'edit-on-github' link to html theme преди 5 години
page_redirects.txt 962ea8b9f2 docs: repurpose WROVER-KIT debugging guide for Kaluga-1 преди 5 години
requirements.txt 7a9abe3ec5 add chart of version support to version.rst преди 5 години
sanitize_version.py 1a2ddcb77a docs: deploy docs to production server from CI преди 5 години
sphinx-known-warnings.txt b6dba84323 ulp: added support to building code for riscv ULP coprocessor преди 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.