Domů Procházet Nápověda
Přihlásit se
RT-Thread-packages
/
esp-idf
zrcadlo https://github-proxy.rt-thread.io/RT-Thread-packages/esp-idf.git
2
0
Rozštěpit 0
Soubory Úkoly 0 Wiki
Strom: afce54540c
Větve Značky
esp-idf
/
docs
Marius Vikhammer 32761b9782 docs: fix link_roles not linking correctly for certain files před 5 roky
..
_static 95ed99671b Merge branch 'feature/coredump_data_in_elf_format_doc_update' into 'master' před 5 roky
en 32761b9782 docs: fix link_roles not linking correctly for certain files před 5 roky
extensions 63b76a9d90 doc: custom list filter directive před 6 roky
idf_extensions 32761b9782 docs: fix link_roles not linking correctly for certain files před 5 roky
latex_templates 407275f681 doc: add latex and PDF generation to build_docs před 5 roky
zh_CN 27f24a5d06 Add dimensions před 5 roky
Doxyfile a171def1ba docs: Redirect all of Doxygen stderr to the warnings log před 5 roky
README.md 416076665b docs: use new sphinx_idf_theme theme, add variables to allow theme to build version footer před 6 roky
TEMPLATE_EXAMPLE_README.md de682a13b1 examples: Update system examples README před 6 roky
build_docs.py 67ea59d605 docs: fix check_docs not working for multiple builders před 5 roky
check_lang_folder_sync.sh e94288da31 global: use '/usr/bin/env bash' instead of '/usr/bin/bash' in shebangs před 5 roky
conf_common.py 7d989e08fd doc: Fix passing of build macros to Doxygen před 5 roky
doxygen-known-warnings.txt 11fac8637a docs: Resolve doxygen & Sphinx warnings před 6 roky
get_github_rev.py 214f1fbbed docs: add 'edit-on-github' link to html theme před 5 roky
page_redirects.txt c65c1716cd Add redirect link from user-guide-kaluga-1-v1.2 to user-guide-esp32-s2-kaluga-1-kit před 5 roky
requirements.txt 8a3d806798 doc: update CI to build PDF před 5 roky
sanitize_version.py 1a2ddcb77a docs: deploy docs to production server from CI před 6 roky
sphinx-known-warnings.txt 67ea59d605 docs: fix check_docs not working for multiple builders před 5 roky

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.