esp-idf/docs
Michael (XIAO Xufeng) d2bb1e1b75 Merge branch 'bugfix/fix_adc_dac_driver_ut' into 'master'
Driver(adc): fix adc driver and UT

See merge request espressif/esp-idf!8482
2020-06-02 17:46:45 +08:00
..
_static Merge branch 'feature/coredump_data_in_elf_format_doc_update' into 'master' 2020-05-28 02:25:47 +08:00
en Merge branch 'bugfix/fix_adc_dac_driver_ut' into 'master' 2020-06-02 17:46:45 +08:00
extensions
idf_extensions
latex_templates
zh_CN docs: fix check_docs not working for multiple builders 2020-05-29 20:10:18 +08:00
Doxyfile
README.md
TEMPLATE_EXAMPLE_README.md
build_docs.py docs: fix check_docs not working for multiple builders 2020-05-29 20:10:18 +08:00
check_lang_folder_sync.sh
conf_common.py docs: fix check_docs not working for multiple builders 2020-05-29 20:10:18 +08:00
doxygen-known-warnings.txt
get_github_rev.py
page_redirects.txt
requirements.txt
sanitize_version.py
sphinx-known-warnings.txt docs: fix check_docs not working for multiple builders 2020-05-29 20:10:18 +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.