Mahavir Jain 61bf801d0f Merge branch 'feature/esp32h2_add_hmac_ds' into 'master' 2 lat temu
..
_static a52aff81a8 usb_host: Add maintainer's notes (Introduction and DWC_OTG Controller) 3 lat temu
docs_not_updated 9a66885af1 docs: remove H2 HMAC and DS chapters from not updated list 2 lat temu
doxygen f27cd67c00 driver: pack peripherals 3 lat temu
en d3fec8394f Merge branch 'feature/adc_filter' into 'master' 2 lat temu
zh_CN d3fec8394f Merge branch 'feature/adc_filter' into 'master' 2 lat temu
README.md 7411321603 docs: update to use esp-docs 4 lat temu
TEMPLATE_EXAMPLE_README.md 5f7733f692 docs: update frontpage/general pages for ESP8684 4 lat temu
check_lang_folder_sync.sh e94288da31 global: use '/usr/bin/env bash' instead of '/usr/bin/bash' in shebangs 5 lat temu
conf_common.py a57496acfe usb_host: Add maintainer's notes (Design, Architecture) 3 lat temu
doxygen-known-warnings.txt c318c89453 freertos(IDF): Remove dependency on portUSING_MPU_WRAPPERS 3 lat temu
page_redirects.txt 57a9c67c01 index 3 lat temu
sphinx-known-warnings.txt 0fcd384677 docs: fix driver sphinx warnings 3 lat temu

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