esp-idf/docs
2024-05-10 11:58:01 +08:00
..
_static feat(docs): added USB Host Stack Configuration description 2024-01-29 10:44:53 +01:00
doxygen docs: fixed missing API-reference documents for Bluetooth HID device 2023-03-14 12:13:48 +08:00
en docs: Update the process of Bluetooth entering sleep in the sleep_modes.rst 2024-05-10 11:58:01 +08:00
zh_CN docs(wifi): update the docmentation for sniffer API 2024-04-17 16:22:08 +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_v4.4' into 'release/v4.4' 2023-03-17 19:40:43 +08:00
doxygen-known-warnings.txt docs: fix all doxygen warnings 2022-07-05 11:14:40 +08: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: redirect console page 2022-11-02 16:08:07 +08:00
README.md docs: update to use esp-docs 2021-08-24 08:56:48 +08:00
requirements.txt docs: fix all doxygen warnings 2022-07-05 11:14:40 +08:00
sphinx-known-warnings.txt component_bt: Fix build doc errors of bt 2022-08-02 13:39:36 +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