esp-idf/docs
Kevin (Lao Kaiyao) 668e125dd4 Merge branch 'feature/support_i2s_on_h2' into 'master'
i2s: support i2s on esp32h2

Closes IDF-6219 and IDF-6700

See merge request espressif/esp-idf!21948
2023-01-19 10:47:33 +08:00
..
_static usb_host: Add maintainer's notes (Introduction and DWC_OTG Controller) 2023-01-13 20:00:18 +08:00
docs_not_updated docs: JTAG debugging update for ESP32C6 2023-01-18 15:17:23 +01:00
doxygen Merge branch 'bugfix/lwip_core_locking' into 'master' 2023-01-18 20:31:25 +08:00
en Merge branch 'feature/support_i2s_on_h2' into 'master' 2023-01-19 10:47:33 +08:00
zh_CN Merge branch 'doc_update_esp32c6_jtag' into 'master' 2023-01-19 03:44:43 +08:00
check_lang_folder_sync.sh global: use '/usr/bin/env bash' instead of '/usr/bin/bash' in shebangs 2020-04-03 01:10:02 +02:00
conf_common.py sdio: c6 doc update 2023-01-18 02:34:46 +00:00
doxygen-known-warnings.txt freertos(IDF): Remove dependency on portUSING_MPU_WRAPPERS 2022-12-23 15:29:17 +08:00
page_redirects.txt index 2022-12-29 01:00:31 +08:00
README.md docs: update to use esp-docs 2021-08-24 08:56:48 +08:00
sphinx-known-warnings.txt docs: fix driver sphinx warnings 2022-12-29 00:59:04 +08:00
TEMPLATE_EXAMPLE_README.md docs: update frontpage/general pages for ESP8684 2021-12-21 11:14:35 +08:00

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