esp-idf/docs
Michael (XIAO Xufeng) 0a2e5a7774 Merge branch 'feat/support_esp32c2_uart' into 'master'
uart: update console docs about frequency for ESP32-C2, move frequency of clock sources out of HAL

Closes IDF-5424 and IDF-4332

See merge request espressif/esp-idf!19274
2022-08-22 14:24:26 +08:00
..
_static Merge branch 'docs/add_pin_layout_diagram_and_notes' into 'master' 2022-08-18 17:16:16 +08:00
docs_not_updated Remove docs not update for classic_bt 2022-08-08 20:51:57 +08:00
doxygen Merge branch 'feature/ulp_mutex' into 'master' 2022-08-21 16:27:53 +08:00
en Merge branch 'feat/support_esp32c2_uart' into 'master' 2022-08-22 14:24:26 +08:00
zh_CN Merge branch 'feature/app_metadata_to_esp_system' into 'master' 2022-08-18 21:51:32 +08:00
README.md
TEMPLATE_EXAMPLE_README.md
check_lang_folder_sync.sh
conf_common.py Merge branch 'docs/update_linkcheck_ignore_c2' into 'master' 2022-08-21 16:28:31 +08:00
doxygen-known-warnings.txt
page_redirects.txt docs: update the link to redirect chip-series-comparison.rst 2022-08-18 08:09:51 +00:00
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 is built using the python package esp-docs, which can be installed by running pip install esp-docs. Running build-docs --help will give a summary of available options. For more information see the esp-docs documentation at https://github.com/espressif/esp-docs/blob/master/README.md