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

History

linruihao 1143fea119 docs: update rf coexistenct api guides 1. support esp32c2 2. fix inconsistency between CN and EN docs of rf coexistence 3. adjust the visibility of some contents based on soc_caps		2024-02-23 16:20:18 +08:00
..
_static	feat(docs): added USB Host Stack Configuration description	2024-02-21 11:33:07 +01:00
docs_not_updated	feat(esp-coredump): add esp32p4 chip support and doc update	2024-02-21 21:26:39 +08:00
doxygen	refactor(esp_srp): Expose esp_srp.h and add API docs	2023-11-23 14:25:53 +05:30
en	docs: update rf coexistenct api guides	2024-02-23 16:20:18 +08:00
zh_CN	docs: update rf coexistenct api guides	2024-02-23 16:20:18 +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-02-20 10:31:29 +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