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: 1a2ddcb77a
Ramas Etiquetas
esp-idf
/
docs
Angus Gratton 1a2ddcb77a docs: deploy docs to production server from CI hace 6 años
..
_static b85358e593 Updated index hace 5 años
en 416076665b docs: use new sphinx_idf_theme theme, add variables to allow theme to build version footer hace 5 años
extensions 63b76a9d90 doc: custom list filter directive hace 6 años
idf_extensions dfc95bc78b docs: multi target include dir support hace 6 años
zh_CN b85358e593 Updated index hace 5 años
Doxyfile 947e3e94ed Add ESP certificate bundle feature hace 6 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 1a2ddcb77a docs: deploy docs to production server from CI hace 5 años
check_lang_folder_sync.sh 621076f329 Introduced a CI check if folders with localized documentation are in sync, i.e. if they contain the same list of files hace 8 años
conf_common.py 1a2ddcb77a docs: deploy docs to production server from CI hace 5 años
doxygen-known-warnings.txt 11fac8637a docs: Resolve doxygen & Sphinx warnings hace 6 años
page_redirects.txt 073ba0a608 feat/secure_boot_v2: Adding docs for secure boot v2 ESP32-ECO3 hace 6 años
requirements.txt 416076665b docs: use new sphinx_idf_theme theme, add variables to allow theme to build version footer hace 5 años
sanitize_version.py 1a2ddcb77a docs: deploy docs to production server from CI hace 5 años
sphinx-known-warnings.txt 11fac8637a docs: Resolve doxygen & Sphinx warnings hace 6 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.