Krzysztof Budzynski ceeb594f2d Merge branch 'contrib/7379' into 'master' %!s(int64=4) %!d(string=hai) anos
..
_static 85f9aa1062 docs: Instructions for Windows download optimization %!s(int64=4) %!d(string=hai) anos
doxygen 7411321603 docs: update to use esp-docs %!s(int64=4) %!d(string=hai) anos
en ceeb594f2d Merge branch 'contrib/7379' into 'master' %!s(int64=4) %!d(string=hai) anos
zh_CN f65c8249af Merge branch 'feature/esp_docs' into 'master' %!s(int64=4) %!d(string=hai) anos
README.md 7411321603 docs: update to use esp-docs %!s(int64=4) %!d(string=hai) anos
TEMPLATE_EXAMPLE_README.md de682a13b1 examples: Update system examples README %!s(int64=6) %!d(string=hai) anos
check_lang_folder_sync.sh e94288da31 global: use '/usr/bin/env bash' instead of '/usr/bin/bash' in shebangs %!s(int64=5) %!d(string=hai) anos
conf_common.py 8b38e9ecf5 docs: fix edit on github link to point to esp-idf %!s(int64=4) %!d(string=hai) anos
doxygen-known-warnings.txt 11fac8637a docs: Resolve doxygen & Sphinx warnings %!s(int64=6) %!d(string=hai) anos
generate_chart.py 0146f258d7 style: format python files with isort and double-quote-string-fixer %!s(int64=5) %!d(string=hai) anos
page_redirects.txt 2218204aa7 doc: update tinyusb document to support esp32s3 %!s(int64=4) %!d(string=hai) anos
requirements.txt 7411321603 docs: update to use esp-docs %!s(int64=4) %!d(string=hai) anos
sphinx-known-warnings.txt e07be3df49 docs: ignore duplicate def warning in BT docs %!s(int64=4) %!d(string=hai) anos

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