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

History

Myk Melez 2654d29bc5 correct typo in reference to ESP-IDF repo There's a reference to the ESP-ADF repo that looks like it was intended to be a reference to the ESP-IDF repo. This branch fixes the reference.		2023-05-04 11:43:08 +08:00
..
_static	doc: added memory management programming guides	2023-03-22 16:33:52 +08:00
docs_not_updated	docs: Update Protocols & Provisioning sections for H2	2023-03-30 18:00:12 +05:30
doxygen	esp_clk_tree: Rename clk_tree_xxx to esp_clk_tree_xxx, add compilation warning to clk_tree.h	2023-04-27 11:11:18 +00:00
en	correct typo in reference to ESP-IDF repo	2023-05-04 11:43:08 +08:00
zh_CN	docs: update translation for esp_eth	2023-05-03 07:39:24 +00: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	ulp: added sleep support for lp core	2023-04-27 09:51:41 +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	docs: update to use esp-docs	2021-08-24 08:56:48 +08:00
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	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