Головна сторінка Огляд Довідка
Увійти
RT-Thread-packages
/
esp-idf
дзеркало https://github-proxy.rt-thread.io/RT-Thread-packages/esp-idf.git
2
0
Відгалуження 0
Файли Проблеми 0 Wiki
Дерево: fb43cfbf6a
Гілки Теги
esp-idf
/
docs
Roland Dobai 23eadafd38 Fix the setup instructions in the main README 5 роки тому
..
_static c863b4c777 docs: tinyusb documentation 5 роки тому
en 23eadafd38 Fix the setup instructions in the main README 5 роки тому
extensions 63b76a9d90 doc: custom list filter directive 6 роки тому
idf_extensions a5e5794059 docs: add a command to create an esp directory before cloning esp-idf 5 роки тому
latex_templates 407275f681 doc: add latex and PDF generation to build_docs 5 роки тому
test ba546a0d91 docs: Adds CI tests for the doc building process. 5 роки тому
zh_CN 22301653c6 VSCode Extension Setup Guide 5 роки тому
Doxyfile 5425ef4ee4 hal: extract hal component from soc component 5 роки тому
README.md 416076665b docs: use new sphinx_idf_theme theme, add variables to allow theme to build version footer 5 роки тому
TEMPLATE_EXAMPLE_README.md de682a13b1 examples: Update system examples README 6 роки тому
build_docs.py 9b552ce004 docs: add warning for doxygen version 5 роки тому
check_lang_folder_sync.sh e94288da31 global: use '/usr/bin/env bash' instead of '/usr/bin/bash' in shebangs 5 роки тому
conf_common.py c863b4c777 docs: tinyusb documentation 5 роки тому
doxygen-known-warnings.txt 11fac8637a docs: Resolve doxygen & Sphinx warnings 6 роки тому
get_github_rev.py 214f1fbbed docs: add 'edit-on-github' link to html theme 5 роки тому
page_redirects.txt 962ea8b9f2 docs: repurpose WROVER-KIT debugging guide for Kaluga-1 5 роки тому
requirements.txt 1f565c2313 docs: Provide missing python requirement 5 роки тому
sanitize_version.py 1a2ddcb77a docs: deploy docs to production server from CI 5 роки тому
sphinx-known-warnings.txt b6dba84323 ulp: added support to building code for riscv ULP coprocessor 5 роки тому

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.