laokaiyao fa4e77eb44 i2s: deprecate confusing names 4 年之前
..
_static 2059280445 Doc/add esp32s3 kevkitm 1 user guide cn and en 4 年之前
doxygen 209702d055 esp_ipc: Update documentation and API descriptions 4 年之前
en fa4e77eb44 i2s: deprecate confusing names 4 年之前
zh_CN fc14d3f9aa Merge branch 'doc/update_usj_docs' into 'master' 4 年之前
README.md 7411321603 docs: update to use esp-docs 4 年之前
TEMPLATE_EXAMPLE_README.md de682a13b1 examples: Update system examples README 6 年之前
check_lang_folder_sync.sh e94288da31 global: use '/usr/bin/env bash' instead of '/usr/bin/bash' in shebangs 6 年之前
conf_common.py 9c1d4f5b54 Build & config: Remove the "make" build system 4 年之前
doxygen-known-warnings.txt 11fac8637a docs: Resolve doxygen & Sphinx warnings 6 年之前
generate_chart.py 0146f258d7 style: format python files with isort and double-quote-string-fixer 5 年之前
page_redirects.txt 2218204aa7 doc: update tinyusb document to support esp32s3 4 年之前
requirements.txt cf0e995fa9 docs: bump esp-docs version to 0.1.1 4 年之前
sphinx-known-warnings.txt e07be3df49 docs: ignore duplicate def warning in BT docs 4 年之前

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