esp-idf/docs
Dai Zi Yan 9998e88ada Merge branch 'docs/add_GPIO_list_for_each_chip' into 'master'
docs:add GPIO reference list for chip ESP32,ESP32-S2 ,  ESP32-C3 and ESP32-S3

Closes DOC-1540

See merge request espressif/esp-idf!14281
2021-08-11 04:10:02 +00:00
..
_static docs/add_esp32-s2-devkitc-1_user_guide 2021-07-30 14:00:45 +08:00
doxygen docs: Separate Doc on WiFi security, added DPP Doc 2021-08-10 12:35:43 +05:30
en Merge branch 'docs/add_GPIO_list_for_each_chip' into 'master' 2021-08-11 04:10:02 +00:00
extensions
idf_extensions docs: add S3 TRM URL 2021-07-12 16:39:23 +08:00
latex_templates
test
zh_CN docs: Separate Doc on WiFi security, added DPP Doc 2021-08-10 12:35:43 +05:30
README.md
TEMPLATE_EXAMPLE_README.md
build_docs.py build docs: enable building of S3 docs 2021-06-09 09:30:36 +08:00
check_lang_folder_sync.sh
conf_common.py doc: update tinyusb document to support esp32s3 2021-07-22 10:43:10 +08:00
doxygen-known-warnings.txt
generate_chart.py
get_github_rev.py
page_redirects.txt doc: update tinyusb document to support esp32s3 2021-07-22 10:43:10 +08:00
requirements.txt
sanitize_version.py
sphinx-known-warnings.txt docs: ignore duplicate def warning in BT docs 2021-06-30 15:10:43 +08: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 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.