Inicio Explorar Ayuda
Iniciar sesión
RT-Thread-packages
/
esp-idf
espejo de https://github-proxy.rt-thread.io/RT-Thread-packages/esp-idf.git
2
0
Fork 0
Archivos Incidencias 0 Wiki
Árbol: 223f800dd7
Ramas Etiquetas
esp-idf
/
docs
Felipe Neves 223f800dd7 expression_with_stack: added a tweak on TCB stackpointers to avoid false trigger of stack overflow hace 5 años
..
_static e6db25af9d TWAI: Add ESP32-S2 support hace 5 años
en 223f800dd7 expression_with_stack: added a tweak on TCB stackpointers to avoid false trigger of stack overflow hace 5 años
extensions 63b76a9d90 doc: custom list filter directive hace 6 años
idf_extensions 5f09ffce96 docs: fix version specific note on local build hace 5 años
latex_templates 407275f681 doc: add latex and PDF generation to build_docs hace 5 años
zh_CN 223f800dd7 expression_with_stack: added a tweak on TCB stackpointers to avoid false trigger of stack overflow hace 5 años
Doxyfile e6db25af9d TWAI: Add ESP32-S2 support hace 5 años
README.md 416076665b docs: use new sphinx_idf_theme theme, add variables to allow theme to build version footer hace 5 años
TEMPLATE_EXAMPLE_README.md de682a13b1 examples: Update system examples README hace 6 años
build_docs.py 010a825f48 docs: adds to build_docs.py an encoding check suitable for windows hace 5 años
check_lang_folder_sync.sh e94288da31 global: use '/usr/bin/env bash' instead of '/usr/bin/bash' in shebangs hace 5 años
conf_common.py 2b270bccbf doc: Fix passing of build macros to Doxygen hace 5 años
doxygen-known-warnings.txt 11fac8637a docs: Resolve doxygen & Sphinx warnings hace 6 años
get_github_rev.py 214f1fbbed docs: add 'edit-on-github' link to html theme hace 5 años
page_redirects.txt e6db25af9d TWAI: Add ESP32-S2 support hace 5 años
requirements.txt 61904135b3 docs: update sphinx_idf_theme documentation hace 5 años
sanitize_version.py 1a2ddcb77a docs: deploy docs to production server from CI hace 5 años
sphinx-known-warnings.txt 302a43562d docs: fix check_docs not working for multiple builders hace 5 años

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.