Inicio Explorar Axuda
Iniciar sesión
RT-Thread-packages
/
esp-idf
réplica de https://github-proxy.rt-thread.io/RT-Thread-packages/esp-idf.git
2
0
Fork 0
Ficheiros Incidencias 0 Wiki
Árbore: bac77b4bf7
Ramas Etiquetas
esp-idf
/
docs
Dai Zi Yan 694dd2767a update CN translation for ulp.rst index.rst bootloader.rst and external-ram.rst under api-guides section %!s(int64=5) %!d(string=hai) anos
..
_static 703aef654b provide user guide for ESP32-DevKitM-1 %!s(int64=5) %!d(string=hai) anos
doxygen da947d736f Docs: Add C3 support to build_docs %!s(int64=5) %!d(string=hai) anos
en ca964dfbcc esp-tls: Changed default behaviour for esp-tls client ( for security %!s(int64=5) %!d(string=hai) anos
extensions 63b76a9d90 doc: custom list filter directive %!s(int64=6) %!d(string=hai) anos
idf_extensions da947d736f Docs: Add C3 support to build_docs %!s(int64=5) %!d(string=hai) anos
latex_templates 66fb5a29bb Whitespace: Automated whitespace fixes (large commit) %!s(int64=5) %!d(string=hai) anos
test ba546a0d91 docs: Adds CI tests for the doc building process. %!s(int64=5) %!d(string=hai) anos
zh_CN 694dd2767a update CN translation for ulp.rst index.rst bootloader.rst and external-ram.rst under api-guides section %!s(int64=5) %!d(string=hai) anos
README.md 416076665b docs: use new sphinx_idf_theme theme, add variables to allow theme to build version footer %!s(int64=5) %!d(string=hai) anos
TEMPLATE_EXAMPLE_README.md de682a13b1 examples: Update system examples README %!s(int64=6) %!d(string=hai) anos
build_docs.py 9b552ce004 docs: add warning for doxygen version %!s(int64=5) %!d(string=hai) anos
check_lang_folder_sync.sh e94288da31 global: use '/usr/bin/env bash' instead of '/usr/bin/bash' in shebangs %!s(int64=5) %!d(string=hai) anos
conf_common.py da947d736f Docs: Add C3 support to build_docs %!s(int64=5) %!d(string=hai) anos
doxygen-known-warnings.txt 11fac8637a docs: Resolve doxygen & Sphinx warnings %!s(int64=6) %!d(string=hai) anos
generate_chart.py 7a9abe3ec5 add chart of version support to version.rst %!s(int64=5) %!d(string=hai) anos
get_github_rev.py 214f1fbbed docs: add 'edit-on-github' link to html theme %!s(int64=5) %!d(string=hai) anos
page_redirects.txt 962ea8b9f2 docs: repurpose WROVER-KIT debugging guide for Kaluga-1 %!s(int64=5) %!d(string=hai) anos
requirements.txt 7a9abe3ec5 add chart of version support to version.rst %!s(int64=5) %!d(string=hai) anos
sanitize_version.py 1a2ddcb77a docs: deploy docs to production server from CI %!s(int64=5) %!d(string=hai) anos
sphinx-known-warnings.txt b6dba84323 ulp: added support to building code for riscv ULP coprocessor %!s(int64=5) %!d(string=hai) anos

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.