Historia

Shang Zhou dd0cf9e935 docs: Update CN translation for ulp-risc-v.rst		2024-02-06 10:56:46 +08:00
..
_static	feat(esp_eth): Added support of internal EMAC for ESP32P4	2024-01-16 14:29:25 +01:00
docs_not_updated	docs(esp32c5): add support for building C5 docs	2024-02-01 10:06:41 +08:00
doxygen	docs(esp32c5): add support for building C5 docs	2024-02-01 10:06:41 +08:00
en	docs: Update CN translation for ulp-risc-v.rst	2024-02-06 10:56:46 +08:00
zh_CN	docs: Update CN translation for ulp-risc-v.rst	2024-02-06 10:56:46 +08:00
README.md	…
TEMPLATE_EXAMPLE_README.md	…
check_lang_folder_sync.sh	…
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(esp32c5): add support for building C5 docs	2024-02-01 10:06:41 +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
sphinx-known-warnings.txt	fix(ble_mesh): Miscellaneous update for ble mesh	2023-09-16 15:58:14 +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