esp-idf/docs
Angus Gratton 2e98a5d796 docs: split the 'general notes' page into two 2021-03-29 16:32:54 +11:00
..
_static Add ESP32-C3-DevKitC-02 User Guide 2021-03-17 06:40:33 +00:00
doxygen docs: update api-reference chapters for C3 2021-03-01 14:58:08 +08:00
en docs: split the 'general notes' page into two 2021-03-29 16:32:54 +11:00
extensions
idf_extensions
latex_templates
test
zh_CN docs: split the 'general notes' page into two 2021-03-29 16:32:54 +11:00
README.md
TEMPLATE_EXAMPLE_README.md
build_docs.py
check_lang_folder_sync.sh
conf_common.py docs: updated system api-reference chapters for C3 2021-03-15 18:51:12 +08:00
doxygen-known-warnings.txt
generate_chart.py
get_github_rev.py
page_redirects.txt
requirements.txt Docs: build doc with new layout for target and version select 2021-03-12 16:15:56 +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.