esp-idf/docs
Michael (XIAO Xufeng) fc2905384c Merge branch 'feature/support_esp32s3_728_gpio_driver' into 'master'
gpio: update gpio driver to support esp32s3

Closes IDF-3224 and IDF-3273

See merge request espressif/esp-idf!13942
2021-06-28 09:49:01 +00:00
..
_static docs: update Windows Tools 2.9 installation 2021-06-21 14:19:40 +02:00
doxygen hal/emac_hal: refactord emac_hal 2021-06-16 09:48:21 +08:00
en Merge branch 'feature/support_esp32s3_728_gpio_driver' into 'master' 2021-06-28 09:49:01 +00:00
extensions doc: Add support for redirects to external URL 2021-04-27 17:01:24 +08:00
idf_extensions build docs: enable building of S3 docs 2021-06-09 09:30:36 +08:00
latex_templates
test
zh_CN apptrace: Refactors apptrace for better support various tracing HW 2021-06-24 13:16:13 +03:00
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 build docs: enable building of S3 docs 2021-06-09 09:30:36 +08:00
doxygen-known-warnings.txt
generate_chart.py
get_github_rev.py
page_redirects.txt Merge branch 'doc/remove_modules_and_boards_section_from_hw_reference' into 'master' 2021-05-31 11:12:51 +00:00
requirements.txt docs: add warning for outdated versions 2021-04-27 09:02:11 +08:00
sanitize_version.py
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 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.