mirror of https://github.com/espressif/esp-idf.git synced 2024-09-20 00:36:01 -04:00

History

Waheed Barghouthi d5bfbfc095 doc: update clk_flags requirement for i2c docs Merges https://github.com/espressif/esp-idf/pull/7637		2022-07-27 11:02:43 +08:00
..
_static	i2s: add slot sequence table	2022-07-21 15:52:39 +08:00
docs_not_updated	docs: update JTAG related information for ESP32-C2	2022-07-14 15:57:43 +02:00
doxygen	doc: update sdm api reference	2022-07-20 14:59:50 +08:00
en	doc: update clk_flags requirement for i2c docs	2022-07-27 11:02:43 +08:00
zh_CN	Merge branch 'docs/add_cn_trans_for_migration_guides_system' into 'master'	2022-07-27 10:45:41 +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	soc: added SOC_TOUCH_SENSE_SUPPORTED macro	2022-07-22 00:12:36 +00:00
doxygen-known-warnings.txt	docs: fix all doxygen warnings	2022-05-12 14:50:03 +08:00
page_redirects.txt	doc: update sdm api reference	2022-07-20 14:59:50 +08:00
README.md	docs: update to use esp-docs	2021-08-24 08:56:48 +08:00
requirements.txt	docs: fix all doxygen warnings	2022-05-12 14:50:03 +08:00
sphinx-known-warnings.txt	fatfs: Add mock option to ff_sdmmc_status function to increase IO speed	2022-06-09 20:09:32 +00: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