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: 09d4767947
Ramas Etiquetas
esp-idf
/
docs
Krzysztof Budzynski 9b309a0a97 Merge branch 'bugfix/doc_fix_dfu' into 'master' %!s(int64=5) %!d(string=hai) anos
..
_static 407275f681 doc: add latex and PDF generation to build_docs %!s(int64=5) %!d(string=hai) anos
en 9b309a0a97 Merge branch 'bugfix/doc_fix_dfu' into 'master' %!s(int64=5) %!d(string=hai) anos
extensions 63b76a9d90 doc: custom list filter directive %!s(int64=6) %!d(string=hai) anos
idf_extensions dc2c753a7d doc: remove links to translation if building PDF %!s(int64=5) %!d(string=hai) anos
latex_templates 407275f681 doc: add latex and PDF generation to build_docs %!s(int64=5) %!d(string=hai) anos
zh_CN f9552baf97 Merge branch 'feature/dfu_build_flash_s2' into 'master' %!s(int64=5) %!d(string=hai) anos
Doxyfile 2da7e65646 Doc: S2 HMAC documentation %!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 407275f681 doc: add latex and PDF generation to build_docs %!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 ab9f714248 Add build system support for programming ESP32-S2 using DFU utils %!s(int64=5) %!d(string=hai) anos
doxygen-known-warnings.txt 11fac8637a docs: Resolve doxygen & Sphinx warnings %!s(int64=6) %!d(string=hai) anos
page_redirects.txt 3dec957bc8 doc: Create redirects for ESP32 hw-reference get-started URLs %!s(int64=5) %!d(string=hai) anos
requirements.txt 8a3d806798 doc: update CI to build PDF %!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 11fac8637a docs: Resolve doxygen & Sphinx warnings %!s(int64=6) %!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.