esp-idf/docs
Darian Leung c46b74191e usb: Add USB Host Library documentation
This commit adds the USB Host Library documentation and fixes some nitpicks
in the Host Stack types.

Closes https://github.com/espressif/esp-idf/issues/6408
2022-02-18 15:51:05 +08:00
..
_static usb: Add USB Host Library documentation 2022-02-18 15:51:05 +08:00
doxygen Merge branch 'bugfix/doc_for_ipc_isr_v4.4' into 'release/v4.4' 2021-12-24 03:35:54 +00:00
en usb: Add USB Host Library documentation 2022-02-18 15:51:05 +08:00
zh_CN docs: update copyright date for docs automatically 2022-02-18 12:59:12 +08:00
README.md docs: update to use esp-docs 2021-08-24 08:56:48 +08:00
TEMPLATE_EXAMPLE_README.md
check_lang_folder_sync.sh
conf_common.py docs: fix html redirects not working 2021-12-07 09:12:46 +08:00
doxygen-known-warnings.txt
generate_chart.py
page_redirects.txt doc: update tinyusb document to support esp32s3 2021-07-22 10:43:10 +08:00
requirements.txt docs: bump esp-docs version to 0.1.1 2021-09-06 14:55:04 +08:00
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 is built using the python package esp-docs, which can be installed by running pip install esp-docs. Running build-docs --help will give a summary of available options. For more information see the esp-docs documentation at https://github.com/espressif/esp-docs/blob/master/README.md