morris 7283e349b9 Merge branch 'refactor/rgb_lcd_callback_add_event_data' into 'master' 4 anni fa
..
_static 5b339fefdc docs/update_esp32-s2_devkit_user_guides 4 anni fa
doxygen aa73e423d4 lcd: initial build of API docs 4 anni fa
en 7283e349b9 Merge branch 'refactor/rgb_lcd_callback_add_event_data' into 'master' 4 anni fa
zh_CN aa73e423d4 lcd: initial build of API docs 4 anni fa
README.md 7411321603 docs: update to use esp-docs 4 anni fa
TEMPLATE_EXAMPLE_README.md de682a13b1 examples: Update system examples README 6 anni fa
check_lang_folder_sync.sh e94288da31 global: use '/usr/bin/env bash' instead of '/usr/bin/bash' in shebangs 5 anni fa
conf_common.py 1cf61c849f docs: enable publishing of S3 docs 4 anni fa
doxygen-known-warnings.txt 11fac8637a docs: Resolve doxygen & Sphinx warnings 6 anni fa
generate_chart.py 0146f258d7 style: format python files with isort and double-quote-string-fixer 5 anni fa
page_redirects.txt 2218204aa7 doc: update tinyusb document to support esp32s3 4 anni fa
requirements.txt cf0e995fa9 docs: bump esp-docs version to 0.1.1 4 anni fa
sphinx-known-warnings.txt e07be3df49 docs: ignore duplicate def warning in BT docs 4 anni fa

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