mirror of https://github.com/espressif/esp-idf.git synced 2024-09-20 00:36:01 -04:00

History

Armando 5e31d4bb2b esp_adc: add adc ulp mode disable enum Prior to this commit, adc ulp is disabled by setting adc_oneshot_unit_init_cfg_t::ulp_mode to false. After this commit, a new enum `ADC_ULP_MODE_DISABLE` is added. So setting `ulp_mode` to `ADC_ULP_MODE_DISABLE`, instead of `false`, to disable the ulp mode.		2022-08-22 11:00:28 +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	esp_adc: add adc ulp mode disable enum	2022-08-22 11:00:28 +08:00
zh_CN	Merge branch 'feature/app_metadata_to_esp_system' into 'master'	2022-08-18 21:51:32 +08:00
check_lang_folder_sync.sh	global: use '/usr/bin/env bash' instead of '/usr/bin/bash' in shebangs	2020-04-03 01:10:02 +02:00
conf_common.py	Merge branch 'docs/update_linkcheck_ignore_c2' into 'master'	2022-08-21 16:28:31 +08:00
doxygen-known-warnings.txt	docs: fix all doxygen warnings	2022-05-12 14:50:03 +08:00
page_redirects.txt	docs: update the link to redirect chip-series-comparison.rst	2022-08-18 08:09:51 +00:00
README.md	docs: update to use esp-docs	2021-08-24 08:56:48 +08:00
sphinx-known-warnings.txt	fatfs: Add mock option to ff_sdmmc_status function to increase IO speed	2022-06-09 20:09:32 +00:00
TEMPLATE_EXAMPLE_README.md	docs: update frontpage/general pages for ESP8684	2021-12-21 11:14:35 +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 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