blackbeard420/esp-idf
1
0
Fork 0
mirror of https://github.com/espressif/esp-idf synced 2025-03-10 01:29:21 -04:00
Code Issues Projects Releases Wiki Activity
esp-idf/docs
History
Armando 984ee9dd38 adc: no longer support adc2 oneshot mode on esp32c3 
Due to HW limitation, we don't support this anymore. On c3, ADC2 under oneshot mode is not stable.

However, you can enable CONFIG_ADC_ONESHOT_FORCE_USE_ADC2_ON_C3 to force use
ADC2.

Refer to errata to know more details:
https://www.espressif.com/sites/default/files/documentation/esp32-c3_errata_en.pdf
2023-02-08 09:04:28 +00:00
..
_static
docs/update_esp32-s2_devkit_user_guides
2022-01-07 16:47:56 +08:00
doxygen
docs: Separate Doc on WiFi security, added DPP Doc
2021-11-25 21:01:29 +08:00
en
adc: no longer support adc2 oneshot mode on esp32c3
2023-02-08 09:04:28 +00:00
extensions
docs: add google analytics tracking
2021-09-10 12:53:50 +08:00
idf_extensions
docs: add C3 TRM links
2021-04-09 15:14:16 +08:00
latex_templates
Whitespace: Automated whitespace fixes (large commit)
2020-11-11 07:36:35 +00:00
test
docs: initial update of programming guide for C3
2021-02-01 15:40:02 +08:00
zh_CN
doc: update wifi amsdu docs
2022-12-28 17:51:40 +08:00
build_docs.py
docs: initial update of programming guide for C3
2021-02-01 15:40:02 +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
Make Classic BT related document links only visible for ESP32
2021-10-29 14:25:31 +08:00
doxygen-known-warnings.txt
…
generate_chart.py
style: format python files with isort and double-quote-string-fixer
2021-01-26 10:49:01 +08:00
get_github_rev.py
docs: add 'edit-on-github' link to html theme
2020-05-06 17:25:23 +08:00
page_redirects.txt
docs: repurpose WROVER-KIT debugging guide for Kaluga-1
2020-07-24 15:54:47 +02:00
README.md
docs: use new sphinx_idf_theme theme, add variables to allow theme to build version footer
2020-03-16 14:36:23 +11:00
requirements.txt
docs: add warning for outdated versions
2021-09-10 12:53:50 +08:00
sanitize_version.py
style: format python files with isort and double-quote-string-fixer
2021-01-26 10:49:01 +08:00
sphinx-known-warnings.txt
component_bt: Fix build doc errors of bt
2022-08-12 12:11:54 +08:00
TEMPLATE_EXAMPLE_README.md
…

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.