mirror of https://github.com/espressif/esp-idf.git synced 2024-09-20 00:36:01 -04:00

History

Lou Tianhao f33188fb35 docs(pm/sleep): rewrite_all_low_to_any_low_when_not_esp32		2023-08-01 11:53:14 +08:00
..
_static	add low power doc and picture	2023-07-06 11:57:38 +00:00
docs_not_updated	docs(openthread): update openthread README for H2 and C6	2023-07-12 15:57:25 +08:00
doxygen	refactor(gpio): per-target gpio number definition	2023-07-03 13:33:11 +08:00
en	docs(pm/sleep): rewrite_all_low_to_any_low_when_not_esp32	2023-08-01 11:53:14 +08:00
zh_CN	docs(pm/sleep): rewrite_all_low_to_any_low_when_not_esp32	2023-08-01 11:53:14 +08:00
check_lang_folder_sync.sh
conf_common.py	component/docs: enable generation of API-reference documents for Bluetooth HID host	2023-06-21 12:02:58 +08:00
doxygen-known-warnings.txt	freertos(IDF): Remove dependency on portUSING_MPU_WRAPPERS	2022-12-23 15:29:17 +08:00
page_redirects.txt	doc: remove left-over legacy event loop docs	2023-03-17 15:37:26 +08:00
README.md
sphinx-known-warnings.txt	heap trace standalone: Fix initialization of the unused linked list, update tests	2023-02-14 09:48:14 +01:00
TEMPLATE_EXAMPLE_README.md

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