mirror of https://github.com/espressif/esp-idf.git synced 2024-10-05 20:47:46 -04:00

History

renpeiying c515d555c2 docs: Update zh_CN translation for MR32736		2024-09-02 11:45:55 +02:00
..
_static	Merge branch 'docs/add_ble_feature_status_table_v5.0' into 'release/v5.0'	2024-08-26 14:02:45 +08:00
docs_not_updated	WDT: implement interrupt wdt and task wdt for ESP32-C2	2022-12-01 10:45:35 +00:00
doxygen	change(wifi): Add supplicant's public API header files to doc	2023-09-25 10:57:11 +05:30
en	docs: Update zh_CN translation for MR32736	2024-09-02 11:45:55 +02:00
zh_CN	docs: Update zh_CN translation for MR32736	2024-09-02 11:45:55 +02:00
check_lang_folder_sync.sh	global: use '/usr/bin/env bash' instead of '/usr/bin/bash' in shebangs	2020-04-03 01:10:02 +02:00
conf_common.py	docs(ble): Updated example links in zh_CN ble-mesh-feature-list.rst	2024-08-22 16:59:21 +08:00
doxygen-known-warnings.txt	docs: fix all doxygen warnings	2022-05-12 14:50:03 +08:00
page_redirects.txt	freertos: Rename SMP changes document to ESP-IDF FreeRTOS	2023-02-17 20:43:30 +08:00
README.md	docs: update to use esp-docs	2021-08-24 08:56:48 +08:00
sphinx-known-warnings.txt	docs(fatfs): Move mentioned APIs to a separate API reference section	2023-08-14 12:59:08 +02:00
TEMPLATE_EXAMPLE_README.md	docs: update frontpage/general pages for ESP8684	2021-12-21 11:14:35 +08:00

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