Anton Maklakov f5b626db63 docs: add CN translation for linux-macos-setup.rst update 3 سال پیش
..
_static edee3ee3cd i2s: add slot sequence table 3 سال پیش
docs_not_updated 2ce10d44ab docs: update JTAG related information for ESP32-C2 3 سال پیش
doxygen 75d411a003 doc: update sdm api reference 3 سال پیش
en 57f231af82 docs: add a suggestion for apple m1 users 3 سال پیش
zh_CN f5b626db63 docs: add CN translation for linux-macos-setup.rst update 3 سال پیش
README.md 7411321603 docs: update to use esp-docs 4 سال پیش
TEMPLATE_EXAMPLE_README.md 5f7733f692 docs: update frontpage/general pages for ESP8684 4 سال پیش
check_lang_folder_sync.sh e94288da31 global: use '/usr/bin/env bash' instead of '/usr/bin/bash' in shebangs 5 سال پیش
conf_common.py 741b031e83 soc: added SOC_TOUCH_SENSE_SUPPORTED macro 3 سال پیش
doxygen-known-warnings.txt c8617fe965 docs: fix all doxygen warnings 3 سال پیش
page_redirects.txt 75d411a003 doc: update sdm api reference 3 سال پیش
requirements.txt c8617fe965 docs: fix all doxygen warnings 3 سال پیش
sphinx-known-warnings.txt 8af790da45 fatfs: Add mock option to ff_sdmmc_status function to increase IO speed 3 سال پیش

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