Historia

David Čermák 8033878507 Merge branch 'bugfix/esp_netif_remove_slip' into 'master' esp_netif: Migrate SLIP interface to user-space Closes IDF-5678 See merge request espressif/esp-idf!19202		2022-08-18 03:53:30 +08:00
..
_static	docs: update the diagram of FSM of I2S	2022-08-08 17:02:49 +08:00
docs_not_updated	Remove docs not update for classic_bt	2022-08-08 20:51:57 +08:00
doxygen	efuse: Adds missing header	2022-08-02 22:43:12 +08:00
en	Merge branch 'bugfix/esp_netif_remove_slip' into 'master'	2022-08-18 03:53:30 +08:00
zh_CN	Docs: Add CN translation for gcc.rst and provisioning.rst	2022-08-15 15:09:27 +08:00
README.md	docs: update to use esp-docs	2021-08-24 08:56:48 +08:00
TEMPLATE_EXAMPLE_README.md	docs: update frontpage/general pages for ESP8684	2021-12-21 11:14:35 +08:00
check_lang_folder_sync.sh	…
conf_common.py	Update BLE documentation scope	2022-08-08 20:51:58 +08: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
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

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