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: 4e4c86b267
Ramas Etiquetas
esp-idf
/
docs
Krzysztof Budzynski 352fcba209 Merge branch 'feature/docs-add-python-clean' into 'master' hace 5 años
..
_static e0a698c242 add docs "How to improve Wi-Fi performance" in api-guides. hace 5 años
en 352fcba209 Merge branch 'feature/docs-add-python-clean' into 'master' hace 5 años
extensions 63b76a9d90 doc: custom list filter directive hace 6 años
idf_extensions c8cd68fbe6 docs: add sphinx warnings in format_idf_target hace 5 años
latex_templates 407275f681 doc: add latex and PDF generation to build_docs hace 5 años
test ba546a0d91 docs: Adds CI tests for the doc building process. hace 5 años
zh_CN 068690e604 Merge branch 'docs/fix_formatting_issues_in_idf_monitor' into 'master' hace 5 años
Doxyfile 6462f9bfe1 esp32, esp32s2: create esp_pm component 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 9b552ce004 docs: add warning for doxygen version 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 7a9abe3ec5 add chart of version support to version.rst hace 5 años
doxygen-known-warnings.txt 11fac8637a docs: Resolve doxygen & Sphinx warnings hace 6 años
generate_chart.py 7a9abe3ec5 add chart of version support to version.rst 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 962ea8b9f2 docs: repurpose WROVER-KIT debugging guide for Kaluga-1 hace 5 años
requirements.txt 7a9abe3ec5 add chart of version support to version.rst hace 5 años
sanitize_version.py 1a2ddcb77a docs: deploy docs to production server from CI hace 5 años
sphinx-known-warnings.txt b6dba84323 ulp: added support to building code for riscv ULP coprocessor 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.