mirror of https://github.com/espressif/esp-idf.git synced 2024-10-05 20:47:46 -04:00

History

Mahavir Jain 719eb6375e docs: add a note regarding EFuse Block9 key purpose quirk for some chips		2023-04-20 14:16:21 +08:00
..
_static	docs/update_esp32-s2_devkit_user_guides	2022-01-07 16:47:56 +08:00
doxygen	all: Apply new version logic (major * 100 + minor)	2023-03-02 03:21:34 +00:00
en	docs: add a note regarding EFuse Block9 key purpose quirk for some chips	2023-04-20 14:16:21 +08:00
extensions	docs: add google analytics tracking	2021-09-10 12:53:50 +08:00
idf_extensions	docs: add C3 TRM links	2021-04-09 15:14:16 +08:00
latex_templates
test	docs: initial update of programming guide for C3	2021-02-01 15:40:02 +08:00
zh_CN	Update the ESP-NOW frame length in docs	2023-04-10 16:51:34 +08:00
build_docs.py	docs: initial update of programming guide for C3	2021-02-01 15:40:02 +08:00
check_lang_folder_sync.sh
conf_common.py	Make Classic BT related document links only visible for ESP32	2021-10-29 14:25:31 +08:00
doxygen-known-warnings.txt
generate_chart.py
get_github_rev.py
page_redirects.txt
README.md
requirements.txt	docs: add warning for outdated versions	2021-09-10 12:53:50 +08:00
sanitize_version.py
sphinx-known-warnings.txt	component_bt: Fix build doc errors of bt	2022-08-12 12:11:54 +08:00
TEMPLATE_EXAMPLE_README.md

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 build requirements Python 3 and running the wrapper ./build_docs.py tool. Running ./build_docs.py --help will give a summary of available options.

See Documenting Code in the ESP-IDF Programming Guide for full information about setting up to build the docs, and how to use the ./build_docs.py tool.