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

History

zhangyanjiao 572f117b79 fix typos in docs		2022-12-16 15:52:21 +08:00
..
_static	doc: add api reference for etm driver	2022-11-23 15:32:34 +08:00
docs_not_updated	doc: gpio glitch filter	2022-12-09 11:33:42 +08:00
doxygen	doc: gpio glitch filter	2022-12-09 11:33:42 +08:00
en	fix typos in docs	2022-12-16 15:52:21 +08:00
zh_CN	fix typos in docs	2022-12-16 15:52:21 +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	doc: add api reference for etm driver	2022-11-23 15:32:34 +08:00
doxygen-known-warnings.txt	docs: fix all doxygen warnings	2022-05-12 14:50:03 +08:00
page_redirects.txt	doc: redirect console page	2022-11-02 14:21:57 +08:00
README.md	docs: update to use esp-docs	2021-08-24 08:56:48 +08:00
sphinx-known-warnings.txt	component manager: add build property `DEPENDENCIES_LOCK`	2022-12-13 15:25: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