esp-idf/docs
Linda 31aa922d67 docs: provide CN translation for peripherals in migration guides 2022-09-16 10:51:01 +08:00
..
_static Docs: update figures for esp32-s3-devkitc-1 user guide 2022-08-31 16:24:58 +08:00
docs_not_updated WDT: implement interrupt wdt and task wdt for ESP32-C2 2022-09-15 14:37:59 +08:00
doxygen
en docs: provide CN translation for peripherals in migration guides 2022-09-16 10:51:01 +08:00
zh_CN docs: provide CN translation for peripherals in migration guides 2022-09-16 10:51:01 +08:00
README.md
TEMPLATE_EXAMPLE_README.md
check_lang_folder_sync.sh
conf_common.py docs: update link for ESP ROM ELF releases 2022-09-01 15:05:26 +04:00
doxygen-known-warnings.txt
page_redirects.txt
sphinx-known-warnings.txt

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