esp-idf/docs
2022-05-03 23:41:02 +02:00
..
_static usb: Add USB Host Library documentation 2022-02-18 15:51:05 +08:00
doxygen Merge branch 'bugfix/doc_for_ipc_isr_v4.4' into 'release/v4.4' 2021-12-24 03:35:54 +00:00
en doc: update usb pins and provide a note in api-reference/uart 2022-05-03 23:41:02 +02:00
zh_CN Merge branch 'docs/update_cn_trans_jtag_debugging_docs_4.4' into 'release/v4.4' 2022-04-20 16:21:04 +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 docs: fix html redirects not working 2021-12-07 09:12:46 +08:00
doxygen-known-warnings.txt docs: Resolve doxygen & Sphinx warnings 2020-02-07 16:37:45 +11:00
generate_chart.py style: format python files with isort and double-quote-string-fixer 2021-01-26 10:49:01 +08:00
page_redirects.txt doc: update tinyusb document to support esp32s3 2021-07-22 10:43:10 +08:00
README.md docs: update to use esp-docs 2021-08-24 08:56:48 +08:00
requirements.txt docs: bump esp-docs version to 0.1.1 2021-09-06 14:55:04 +08:00
sphinx-known-warnings.txt docs: ignore duplicate def warning in BT docs 2021-06-30 15:10:43 +08:00
TEMPLATE_EXAMPLE_README.md examples: Update system examples README 2019-08-28 16:19:40 +08:00

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