esp-idf/docs
Jiang Jiang Jian b145507fff Merge branch 'docs/add_missing_usb_functions_to_esp32-c3_devkit_user_guides_v4.4' into 'release/v4.4'
Docs: Added missing USB functions to ESP32-C3 DevKit User Guides (v4.4)

See merge request espressif/esp-idf!30870
2024-06-14 10:21:03 +08:00
..
_static docs(esp32c3): Added missing USB functions to esp32-c3 devkit user guides 2024-05-16 11:49:32 +08:00
doxygen docs: fixed missing API-reference documents for Bluetooth HID device 2023-03-14 12:13:48 +08:00
en docs(esp32c3): Added missing USB functions to esp32-c3 devkit user guides 2024-05-16 11:49:32 +08:00
zh_CN Merge branch 'docs/add_missing_usb_functions_to_esp32-c3_devkit_user_guides_v4.4' into 'release/v4.4' 2024-06-14 10:21:03 +08:00
README.md
TEMPLATE_EXAMPLE_README.md
check_lang_folder_sync.sh
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
generate_chart.py
page_redirects.txt
requirements.txt
sphinx-known-warnings.txt

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