esp-idf/docs
Krzysztof 5a8a6c8fff docs: Provide new links to documentation for ESP32-S2 and ESP32-C3 chips 2021-02-18 18:08:58 +08:00
..
_static docs: Provide new links to documentation for ESP32-S2 and ESP32-C3 chips 2021-02-18 18:08:58 +08:00
doxygen docs: reorder the sequence of headers 2021-02-06 20:52:28 +08:00
en Merge branch 'feature/ulp_c3_not_exists_update_doc' into 'master' 2021-02-15 23:09:54 +00:00
extensions
idf_extensions
latex_templates
test
zh_CN tools: Prefer python3 during install and export 2021-02-13 11:34:40 +01:00
README.md
TEMPLATE_EXAMPLE_README.md
build_docs.py
check_lang_folder_sync.sh
conf_common.py Add ESP32-C3-DevKitM-1 User Guide and updated ESP32C3_DOCS 2021-02-05 12:08:21 +08:00
doxygen-known-warnings.txt
generate_chart.py
get_github_rev.py
page_redirects.txt
requirements.txt
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.