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

History

Shu Chen 6bc666064a docs(ieee802154): add migration note for the receive done handler feature		2024-01-25 20:27:14 +08:00
..
_static	feat(esp_eth): Added support of internal EMAC for ESP32P4	2024-01-16 14:29:25 +01:00
docs_not_updated	Merge branch 'doc/esp32p4_intr_alloc' into 'master'	2024-01-19 10:50:42 +08:00
doxygen	Merge branch 'feature/p4_emac' into 'master'	2024-01-17 22:22:05 +08:00
en	docs(ieee802154): add migration note for the receive done handler feature	2024-01-25 20:27:14 +08:00
zh_CN	docs(ieee802154): add migration note for the receive done handler feature	2024-01-25 20:27:14 +08: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
component_info_ignore_file.txt	docs(ulp): add info about lp-uart to lp-core docs	2023-10-23 12:11:34 +08:00
conf_common.py	docs(ieee802154): add migration note for the receive done handler feature	2024-01-25 20:27:14 +08:00
doxygen-known-warnings.txt	change(freertos/idf): Update FreeRTOS documentation build	2023-10-21 04:39:17 +08:00
page_redirects.txt	doc: remove left-over legacy event loop docs	2023-03-17 15:37:26 +08:00
README.md	docs: update to use esp-docs	2021-08-24 08:56:48 +08:00
sphinx-known-warnings.txt	fix(ble_mesh): Miscellaneous update for ble mesh	2023-09-16 15:58:14 +08: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