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

History

Roland Dobai efc3357f1a Merge branch 'feature/semihosting_call_number_change' into 'master' Semihosting V2 Closes IDF-4893 See merge request espressif/esp-idf!17412		2022-05-07 00:28:48 +08:00
..
_static	doc: apply wavedrom extension	2022-05-01 22:58:19 +08:00
docs_not_updated	dedic_gpio: mention the overhead of using driver API	2022-05-06 18:18:39 +08:00
doxygen	Merge branch 'docs/update_esp_hid_device' into 'master'	2022-05-05 23:58:07 +08:00
en	Merge branch 'feature/semihosting_call_number_change' into 'master'	2022-05-07 00:28:48 +08:00
zh_CN	docs:update a command in partition-tables	2022-05-06 14:14:40 +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	Merge branch 'docs/update_esp_hid_device' into 'master'	2022-05-05 23:58:07 +08:00
doxygen-known-warnings.txt	docs: Resolve doxygen & Sphinx warnings	2020-02-07 16:37:45 +11: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: update esp-docs 1.0.0	2022-04-25 12:07:11 +08:00
sphinx-known-warnings.txt	doc: add esp_hd_cb_t type definition as known warnings	2022-05-06 18:35:56 +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