esp-idf/docs
Wang Fang db86b59330 Merge branch 'docs/update_cn_trans_for_22755' into 'master'
docs: Update CN translation for auto_suspend.inc (!22755)

Closes DOC-5790

See merge request espressif/esp-idf!25236
2023-08-24 11:00:46 +08:00
..
_static docs (Bluetooth): add bluetooth overview document 2023-08-15 11:13:14 +08:00
docs_not_updated update p4 BLE docs 2023-08-17 19:58:01 +08:00
doxygen docs(esp32p4): added building docs for ESP32-P4 2023-08-16 10:13:47 +08:00
en Merge branch 'docs/update_cn_trans_for_22755' into 'master' 2023-08-24 11:00:46 +08:00
zh_CN Merge branch 'docs/update_cn_trans_for_22755' into 'master' 2023-08-24 11:00:46 +08:00
README.md
TEMPLATE_EXAMPLE_README.md
check_lang_folder_sync.sh
conf_common.py Merge branch 'docs/add_bluetooth_overview_page' into 'master' 2023-08-16 19:02:16 +08:00
doxygen-known-warnings.txt
page_redirects.txt
sphinx-known-warnings.txt docs(fatfs): Move mentioned APIs to a separate API reference section 2023-08-04 23:47:44 +00: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