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

History

Michael (XIAO Xufeng) a0c2252756 build_system: fixed issue that default.target may override other custom configs		2022-06-02 11:08:59 +08:00
..
_static	doc: update api reference for new rmt driver	2022-05-07 10:34:50 +00:00
docs_not_updated	doc(esp32c2): Updates Flash Encryption chapter	2022-05-31 11:12:21 +00:00
doxygen	Added BT_SDP API reference document	2022-05-28 23:34:21 +00:00
en	build_system: fixed issue that default.target may override other custom configs	2022-06-02 11:08:59 +08:00
zh_CN	tools: Increase the minimal supported CMake version to 3.16	2022-06-01 06:35:02 +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	Added BT_SDP API reference document	2022-05-28 23:34:21 +00:00
doxygen-known-warnings.txt	docs: fix all doxygen warnings	2022-05-12 14:50:03 +08:00
page_redirects.txt	docs: add cn trans for system.rst	2022-04-20 13:07:38 +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	doc: move mqtt_client.h into known warnings	2022-05-18 16:28:19 +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