Startseite Erkunden Hilfe
Anmelden
RT-Thread-packages
/
esp-idf
Mirror von https://github-proxy.rt-thread.io/RT-Thread-packages/esp-idf.git
2
0
Fork 0
Dateien Issues 0 Wiki
Struktur: 3cc2d0e9a4
Branches Tags
esp-idf
/
docs
Angus Gratton 084e170a8f Merge branch 'refactor/esp_ipc' into 'master' vor 5 Jahren
..
_static 71d1b32dde docs: Provide link to ESP32-S2 specific documentation vor 5 Jahren
en b3587ff88c Merge branch 'bugfix/fix_i2s_comm_format_unclear_description_bug' into 'master' vor 5 Jahren
extensions 63b76a9d90 doc: custom list filter directive vor 6 Jahren
idf_extensions fa0dd5cc7b Merge branch 'doc/view_github_link' into 'master' vor 5 Jahren
latex_templates 407275f681 doc: add latex and PDF generation to build_docs vor 5 Jahren
zh_CN 56635f22b8 Merge branch 'doc/add_types_api_ref' into 'master' vor 5 Jahren
Doxyfile 11d96b39d0 esp_ipc: Move to new component vor 5 Jahren
README.md 416076665b docs: use new sphinx_idf_theme theme, add variables to allow theme to build version footer vor 5 Jahren
TEMPLATE_EXAMPLE_README.md de682a13b1 examples: Update system examples README vor 6 Jahren
build_docs.py a316082f53 docs: support building a subset of the documentation with build_docs vor 5 Jahren
check_lang_folder_sync.sh e94288da31 global: use '/usr/bin/env bash' instead of '/usr/bin/bash' in shebangs vor 5 Jahren
conf_common.py fa0dd5cc7b Merge branch 'doc/view_github_link' into 'master' vor 5 Jahren
doxygen-known-warnings.txt 11fac8637a docs: Resolve doxygen & Sphinx warnings vor 6 Jahren
get_github_rev.py 214f1fbbed docs: add 'edit-on-github' link to html theme vor 5 Jahren
page_redirects.txt c65c1716cd Add redirect link from user-guide-kaluga-1-v1.2 to user-guide-esp32-s2-kaluga-1-kit vor 5 Jahren
requirements.txt 8a3d806798 doc: update CI to build PDF vor 5 Jahren
sanitize_version.py 1a2ddcb77a docs: deploy docs to production server from CI vor 5 Jahren
sphinx-known-warnings.txt 11fac8637a docs: Resolve doxygen & Sphinx warnings vor 6 Jahren

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.