Roland Dobai 1056a7da64 Docs: Fix long lines in the coredump documentation 4 年 前
..
_static ada1c9c5b8 usb: Add USB Host Library documentation 4 年 前
docs_not_updated 95c34696c4 Merge branch 'docs/esp8684_frontpages' into 'master' 4 年 前
doxygen e36f47a153 doc: API reference for GPTimer 4 年 前
en 1056a7da64 Docs: Fix long lines in the coredump documentation 4 年 前
zh_CN 5145183947 Merge branch 'refactor/timer_group_new_api' into 'master' 4 年 前
README.md 7411321603 docs: update to use esp-docs 4 年 前
TEMPLATE_EXAMPLE_README.md 5f7733f692 docs: update frontpage/general pages for ESP8684 4 年 前
check_lang_folder_sync.sh e94288da31 global: use '/usr/bin/env bash' instead of '/usr/bin/bash' in shebangs 5 年 前
conf_common.py 3e56ba05cc docs: fix missing static file path 4 年 前
doxygen-known-warnings.txt 11fac8637a docs: Resolve doxygen & Sphinx warnings 6 年 前
generate_chart.py 0146f258d7 style: format python files with isort and double-quote-string-fixer 5 年 前
page_redirects.txt 2218204aa7 doc: update tinyusb document to support esp32s3 4 年 前
requirements.txt 82325f6037 docs: update docs to be able to build with esp8684 4 年 前
sphinx-known-warnings.txt e07be3df49 docs: ignore duplicate def warning in BT docs 4 年 前

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