esp-idf/docs
morris 5145183947 Merge branch 'refactor/timer_group_new_api' into 'master'
 GPTimer driver (previous Timer Group)

Closes IDF-2082 and IDF-2883

See merge request espressif/esp-idf!8317
2022-01-07 10:54:32 +00:00
..
_static usb: Add USB Host Library documentation 2022-01-06 15:15:32 +08:00
docs_not_updated Merge branch 'docs/esp8684_frontpages' into 'master' 2022-01-04 08:47:42 +00:00
doxygen doc: API reference for GPTimer 2022-01-07 14:59:09 +08:00
en Merge branch 'refactor/timer_group_new_api' into 'master' 2022-01-07 10:54:32 +00:00
zh_CN Merge branch 'refactor/timer_group_new_api' into 'master' 2022-01-07 10:54:32 +00: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 docs: fix missing static file path 2021-12-29 13:57:30 +08:00
doxygen-known-warnings.txt
generate_chart.py
page_redirects.txt doc: update tinyusb document to support esp32s3 2021-07-22 10:43:10 +08:00
requirements.txt docs: update docs to be able to build with esp8684 2021-12-20 10:32:49 +08:00
sphinx-known-warnings.txt docs: ignore duplicate def warning in BT docs 2021-06-30 15:10:43 +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