Accueil Explorer Aide
Connexion
RT-Thread-packages
/
esp-idf
miroir de https://github-proxy.rt-thread.io/RT-Thread-packages/esp-idf.git
2
0
Fork 0
Fichiers Tickets 0 Wiki
Aborescence: ea9322937f
Branches Tags
esp-idf
/
docs
Angus Gratton ea9322937f docs: Log the full list of macros, remove code-style macros to prevent Doxygen errors il y a 5 ans
..
_static 95ed99671b Merge branch 'feature/coredump_data_in_elf_format_doc_update' into 'master' il y a 5 ans
en eef0e178a0 Merge branch 'feature/msys2_env_update' into 'master' il y a 5 ans
extensions 63b76a9d90 doc: custom list filter directive il y a 6 ans
idf_extensions ea9322937f docs: Log the full list of macros, remove code-style macros to prevent Doxygen errors il y a 5 ans
latex_templates 407275f681 doc: add latex and PDF generation to build_docs il y a 5 ans
zh_CN eef0e178a0 Merge branch 'feature/msys2_env_update' into 'master' il y a 5 ans
Doxyfile 516680a4ff Doc: DS documentation for S2 il y a 5 ans
README.md 416076665b docs: use new sphinx_idf_theme theme, add variables to allow theme to build version footer il y a 5 ans
TEMPLATE_EXAMPLE_README.md de682a13b1 examples: Update system examples README il y a 6 ans
build_docs.py 67ea59d605 docs: fix check_docs not working for multiple builders il y a 5 ans
check_lang_folder_sync.sh e94288da31 global: use '/usr/bin/env bash' instead of '/usr/bin/bash' in shebangs il y a 5 ans
conf_common.py 7d989e08fd doc: Fix passing of build macros to Doxygen il y a 5 ans
doxygen-known-warnings.txt 11fac8637a docs: Resolve doxygen & Sphinx warnings il y a 6 ans
get_github_rev.py 214f1fbbed docs: add 'edit-on-github' link to html theme il y a 5 ans
page_redirects.txt c65c1716cd Add redirect link from user-guide-kaluga-1-v1.2 to user-guide-esp32-s2-kaluga-1-kit il y a 5 ans
requirements.txt 8a3d806798 doc: update CI to build PDF il y a 5 ans
sanitize_version.py 1a2ddcb77a docs: deploy docs to production server from CI il y a 5 ans
sphinx-known-warnings.txt 67ea59d605 docs: fix check_docs not working for multiple builders il y a 5 ans

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.