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

History

morris 044a114e66 gptimer: unify clock setting with clk_tree API		2023-02-08 16:30:47 +08:00
..
_static	usb_host: Add maintainer's notes (Introduction and DWC_OTG Controller)	2023-01-13 20:00:18 +08:00
docs_not_updated	etm: add basic driver on esp32h2	2023-02-07 14:54:08 +00:00
doxygen	driver: pack peripherals	2023-02-02 18:19:58 +08:00
en	gptimer: unify clock setting with clk_tree API	2023-02-08 16:30:47 +08:00
zh_CN	gptimer: unify clock setting with clk_tree API	2023-02-08 16:30:47 +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
conf_common.py	usb_host: Add maintainer's notes (Design, Architecture)	2023-01-24 02:49:35 +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	index	2022-12-29 01:00:31 +08:00
README.md	docs: update to use esp-docs	2021-08-24 08:56:48 +08:00
sphinx-known-warnings.txt	docs: fix driver sphinx warnings	2022-12-29 00:59:04 +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