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: f5f90abc95
Ramas Etiquetas
esp-idf
/
docs
morris d4fe219c49 mcpwm: refactor driver hace 5 años
..
_static 997170ede1 Merge branch 'docs/introduce_new_rules_for_updating_docs' into 'master' hace 4 años
doxygen bdfda351bd build docs: enable building of S3 docs hace 4 años
en d4fe219c49 mcpwm: refactor driver hace 4 años
extensions 50fe1eea15 doc: Add support for redirects to external URL hace 4 años
idf_extensions bdfda351bd build docs: enable building of S3 docs hace 4 años
latex_templates 66fb5a29bb Whitespace: Automated whitespace fixes (large commit) hace 5 años
test 548fd02d10 docs: initial update of programming guide for C3 hace 5 años
zh_CN fbd6e9e320 docs: remove duplicate label hace 4 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 bdfda351bd build docs: enable building of S3 docs hace 4 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 bdfda351bd build docs: enable building of S3 docs hace 4 años
doxygen-known-warnings.txt 11fac8637a docs: Resolve doxygen & Sphinx warnings hace 6 años
generate_chart.py 0146f258d7 style: format python files with isort and double-quote-string-fixer hace 5 años
get_github_rev.py 214f1fbbed docs: add 'edit-on-github' link to html theme hace 5 años
page_redirects.txt c07f21a467 Merge branch 'doc/remove_modules_and_boards_section_from_hw_reference' into 'master' hace 4 años
requirements.txt e8b7d2ca08 docs: add warning for outdated versions hace 4 años
sanitize_version.py 0146f258d7 style: format python files with isort and double-quote-string-fixer hace 5 años
sphinx-known-warnings.txt 9295e54c9d docs: Adds secure_boot_v2 for ESP32-C3 ECO3 hace 4 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.