esp-idf/docs
Michael (XIAO Xufeng) 18bee2380a Merge branch 'refactor/usb_device_driver' into 'master'
tiny_usb: support on esp32-s3

Closes IDF-3234

See merge request espressif/esp-idf!14293
2021-07-26 16:21:55 +00:00
..
_static doc: update tinyusb document to support esp32s3 2021-07-22 10:43:10 +08:00
doxygen esp32: move spiram, himem 2021-07-16 20:14:26 +08:00
en Merge branch 'refactor/usb_device_driver' into 'master' 2021-07-26 16:21:55 +00:00
extensions
idf_extensions docs: add S3 TRM URL 2021-07-12 16:39:23 +08:00
latex_templates
test
zh_CN Merge branch 'refactor/usb_device_driver' into 'master' 2021-07-26 16:21:55 +00:00
README.md
TEMPLATE_EXAMPLE_README.md
build_docs.py
check_lang_folder_sync.sh
conf_common.py doc: update tinyusb document to support esp32s3 2021-07-22 10:43:10 +08:00
doxygen-known-warnings.txt
generate_chart.py
get_github_rev.py
page_redirects.txt doc: update tinyusb document to support esp32s3 2021-07-22 10:43:10 +08:00
requirements.txt
sanitize_version.py
sphinx-known-warnings.txt docs: ignore duplicate def warning in BT docs 2021-06-30 15:10:43 +08:00

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.