Commit Graph

771 Commits

Author SHA1 Message Date
weitianhua
f4aad85f8b Make Classic BT related document links only visible for ESP32 2021-10-29 14:21:12 +08:00
Alexey Gerenkov
3af4c22f29 Merge branch 'bugfix/oocd_config_file_for_esp32s3' into 'master'
docs/esp32s3: Fixes OpenOCD configuration files names

See merge request espressif/esp-idf!15478
2021-10-19 19:07:54 +00:00
Wang Ning
d1ae534250 Merge branch 'docs/fix_typos_in_esp32-s2-saola-1_user_guide' into 'master'
Docs: Fixed typos in ESP32-S2-Saola-1 user guide

See merge request espressif/esp-idf!15552
2021-10-19 06:06:56 +00:00
Ivan Grokhotkov
c77950e9fe Merge branch 'doc/api_stability' into 'master'
docs: add a section about API conventions and stability

Closes IDFGH-2658

See merge request espressif/esp-idf!14449
2021-10-18 14:19:12 +00:00
Wang Ning
c0eaa1d99d docs/fixed_typos_in_esp32-s2-saola-1_user_guide 2021-10-18 16:54:44 +08:00
Shang Zhou
3ffc5f0c67 docs:update CN translation for API reference storage(fatfs and index) 2021-10-15 18:59:22 +08:00
Juraj Sadel
eb86d39136 Merge branch 'feature/xtensa-esp32-elf-clang' into 'master'
tools: LLVM for Xtensa (ESP32-S2) based on clang

See merge request espressif/esp-idf!15094
2021-10-14 06:40:48 +00:00
Marek Fiala
582a39126a Merge branch 'feature/idfpy_dashes_replace' into 'master'
tools: replace _ with - in idf.py

Closes IDFGH-3105

See merge request espressif/esp-idf!14752
2021-10-13 13:14:06 +00:00
Juraj Sadel
1a88d5a736 LLVM for Xtensa (ESP32, ESP32-S2) based on clang 2021-10-13 13:45:56 +02:00
Marek Fiala
ff18a96f7d tools: replace _ with - in idf.py
Closes https://github.com/espressif/esp-idf/issues/5126
2021-10-13 17:30:38 +08:00
chenjianxing
2a09234957 esp_phy: rename esp_phy component prefix 2021-10-13 13:10:49 +08:00
Kevin (Lao Kaiyao)
a9faafee3c Merge branch 'feature/touch_sensor_driver_support_for_esp32s3' into 'master'
driver(touch): support touch sensor for esp32s3 platform

Closes IDF-1784 and IDF-3302

See merge request espressif/esp-idf!14102
2021-10-12 05:50:58 +00:00
Alexey Gerenkov
6d9fbc3726 docs/esp32s3: Fixes OpenOCD configuration files names 2021-10-11 22:15:31 +03:00
WangShichang
9f37cfc7fc add docs "How to improve Wi-Fi performance" in api-guides for esp32s3. 2021-10-11 15:08:02 +08:00
Jakob Hasse
f86e154a56 Merge branch 'feature/removed_hyphens_from_examples' into 'master'
[examples]: Project names consistent with their directories

Closes IDFGH-3673

See merge request espressif/esp-idf!13570
2021-10-11 03:43:37 +00:00
Jakob Hasse
81e9266204 [examples]: removed hyphens
Replaced hyphens with underscores in examples
project definition for all examples which had
hyphens in their project name. dpp-enrollee is
an exceptions because the name matches the
project directory name while the project
directory also contains hyphens.
2021-10-09 13:58:24 +08:00
laokaiyao
a1cadba191 touch_sensor: apply general check 2021-10-08 11:32:12 +08:00
laokaiyao
fc73e2b7bd doc/touch: update touch sensor doc for S3 2021-10-08 10:39:46 +08:00
suda-morris
aa73e423d4 lcd: initial build of API docs 2021-10-02 14:23:31 +08:00
Darian
23a03a3bdb Merge branch 'docs/update_CN_trans_i2c_ledc' into 'master'
docs:update CN translation for bootloader, partition-tables, i2c, and ledc

See merge request espressif/esp-idf!15118
2021-09-23 18:13:54 +00:00
Wang Ning
5b339fefdc docs/update_esp32-s2_devkit_user_guides 2021-09-22 14:59:06 +08:00
daiziyan
aca4a18c50 docs:update CN translation for bootloader, partition-tables, i2c, and ledc 2021-09-18 19:25:38 +08:00
Wang Ning
769a9fa28f docs/update_two_esp32-c3_devkit_user_guides 2021-09-18 18:46:42 +08:00
Wang Fang
e43df5fce9 Merge branch 'docs/update_devkitc_and_wrover_kit_boards' into 'master'
docs: udpate devkitc and wrover-kit boards

Closes DOC-1241, DOC-1195, and DOC-1927

See merge request espressif/esp-idf!14945
2021-09-15 07:27:55 +00:00
Wang Fang
781d760873 docs: udpate devkitc and wrover-kit boards 2021-09-13 18:58:45 +08:00
Marius Vikhammer
0daa30c02c docs: remove "invisible" unicode character that failed PDF build. 2021-09-13 10:11:08 +08:00
daiziyan
c9e5b02c18 docs: update CN trans for blufi and build-system 2021-09-10 15:09:50 +08:00
Ivan Grokhotkov
19a75177a8 docs: fix syntax errors in only:: blocks 2021-09-07 14:00:53 +08:00
Shang Zhou
be189b1cfd updated the TOC of ESP-IDF API Reference to make it consistet with the real section title 2021-09-03 16:27:14 +08:00
Darian
c8aab00fdb Merge branch 'feature/usb_host_docs' into 'master'
Add USB Host Library API docs

See merge request espressif/esp-idf!15013
2021-09-02 14:05:08 +00:00
Darian Leung
963836f491 Add USB Host Library API docs
- This commit adds the API documentation for the USB Host Library.
- Warnings about the beta API are also added.
- usb_host_misc.h renamed to usb_helpers.h
2021-09-02 18:40:24 +08:00
Ivan Grokhotkov
c8640d38a7 docs: add a section about API conventions and stability
Closes https://github.com/espressif/esp-idf/issues/4732
2021-08-31 14:41:48 +02:00
Sergei Silnov
8202c12a83 docs: Add component manager documentation 2021-08-30 13:23:23 +02:00
intern
45925c28fd docs: update translation for jtag-debugging/index.rst and power_management.rst 2021-08-26 12:21:19 +08:00
Zim Kalinowski
f65c8249af Merge branch 'feature/esp_docs' into 'master'
docs: update to use esp-docs

Closes IDF-3105

See merge request espressif/esp-idf!13333
2021-08-24 00:56:57 +00:00
Marius Vikhammer
7411321603 docs: update to use esp-docs 2021-08-24 08:56:48 +08:00
Ivan Grokhotkov
6cf25ce43f Merge branch 'doc/size_opt_vfs' into 'master'
docs: describe code size optimizations possible in VFS component

See merge request espressif/esp-idf!14783
2021-08-23 07:32:14 +00:00
Krzysztof Budzynski
b4bfebaeec Merge branch 'docs/windows_installer_optimize_download' into 'master'
docs: Instructions for Windows download optimization

See merge request espressif/esp-idf!14707
2021-08-23 06:43:08 +00:00
Ivan Grokhotkov
a005e9bfbc docs: move VFS documentation into the component directory
These files were added into the component directory back when we
didn't have the documentation directory, and weren't moved once the
documentation directory was created.
2021-08-23 07:02:19 +02:00
Krzysztof Budzynski
6b9cc71931 Merge branch 'docs/update_CN_trans_FatalErrors_UnitTests' into 'master'
update CN translation for fatal-errors and unit-tests

See merge request espressif/esp-idf!14598
2021-08-23 04:07:07 +00:00
Wang Ning
baf8e4694c docs/update_module_flash_size_in_ESP32-S2-DevKitC-1_user_guide 2021-08-19 17:01:58 +08:00
daiziyan
65961ea892 docs: update CN trans for fatal-errors and unit-tests 2021-08-18 19:28:16 +08:00
Juraj Sadel
85f9aa1062 docs: Instructions for Windows download optimization 2021-08-16 12:32:21 +02:00
daiziyan
c399251eda docs: update CN trans for flash-encryption 2021-08-16 16:46:04 +08:00
Pedro Minatel
d4bd603745 Merge branch 'docs/frameworks_and_libs_update' into 'master'
Docs Frameworks and libraries update

See merge request espressif/esp-idf!14284
2021-08-12 10:25:22 +00:00
pedro.minatel
1e14b495b8 Added libraries and frameworks to the docs reference
Added libs-frameworks file for Espressifs libraries and frameworks
Added file on zh_CH
Added description about ESP-MESH
Changes according to the MR revision
Fix on the CSI description
Suggestions applied according to the MR review
2021-08-12 09:21:58 +01:00
Nachiket Kukade
f38b18f046 docs: Separate Doc on WiFi security, added DPP Doc
1. Add new Doc on WiFi security
2. Add DPP related Doc under WiFi
3. Add Supplicant public headers in Doxyfile
2021-08-10 12:35:43 +05:30
Wang Fang
59aa60d52a Merge branch 'docs/provide_apb_clock_frequency_in_api-reference_timers' into 'master'
docs: provide APB clock frequency in api-reference/timers

Closes DOC-1689

See merge request espressif/esp-idf!14593
2021-08-06 06:50:26 +00:00
Wang Fang
0ba73ee7e2 docs: provide APB clock frequency in api-reference/timers 2021-08-06 11:05:32 +08:00
Shu Chen
ee6b1736c6 Merge branch 'feature/add-openthread-docs' into 'master'
docs: add OpenThread docs

See merge request espressif/esp-idf!14488
2021-08-05 03:56:43 +00:00
Jiacheng Guo
ba5b7ddded docs: add OpenThread docs 2021-08-02 17:17:38 +08:00
Armando (Dou Yiwen)
0dad76329f Merge branch 'feature/support_noinit_section_in_psram_on_esp32' into 'master'
memory: support noinit section in psram on esp32

Closes IDFGH-2621

See merge request espressif/esp-idf!14088
2021-07-31 09:58:59 +00:00
Armando
e0acefbb78 docs: add docs to .bss and .noinit segments on spiram 2021-07-31 11:02:13 +08:00
Wang Ning
baebf74342 docs/add_esp32-s2-devkitc-1_user_guide 2021-07-30 14:00:45 +08:00
Wang Fang
8a6fa2f86c Merge branch 'docs/add_a_note_and_module_variants_to_esp32-devkitm-1_pico-devkitm-02u' into 'master'
Add a note to ESP32-DevKitM-1 User Guide, to enable single core mode
Add new module variants for ESP32-DevKitM-1 and ESP32-PICO-DevKitM-02 boards
Replace Ordering Information globally

Closes DOC-1620, DOC-1741, and DOC-1774

See merge request espressif/esp-idf!14479
2021-07-30 03:23:08 +00:00
Wang Fang
03669abead Add a note to ESP32-DevKtiM-1 User Guide, to enable single core mode
Add new module variants for ESP32-DevKitM-1 and ESP32-PICO-DevKitM-02 boards
Replace Ordering Information globally
2021-07-29 18:44:30 +08:00
Michael (XIAO Xufeng)
18bee2380a Merge branch 'refactor/usb_device_driver' into 'master'
tiny_usb: support on esp32-s3

Closes IDF-3234

See merge request espressif/esp-idf!14293
2021-07-26 16:21:55 +00:00
daiziyan
ce916db7ed docs: update all documents in get started section and keep line number consistent 2021-07-22 15:54:47 +08:00
morris
2218204aa7 doc: update tinyusb document to support esp32s3
1. Renamed SOC_USB_SUPPORTED to SOC_USB_OTG_SUPPORTED for the reason of
   another USB related peripheral: USB_JTAG_SERIAL
2. correct related document
2021-07-22 10:43:10 +08:00
Cao Sen Miao
69ad24c943 temp_sensor: add docs for esp32c3 2021-07-21 13:34:52 +08:00
Hao Ning
54e1c52beb docs:fix wrong event names in wifi driver 2021-07-20 19:21:43 +08:00
Angus Gratton
c1ca7a35b0 ldgen: Remove some remaining references to TARGET.project.ld.in 2021-07-16 20:14:27 +08:00
Angus Gratton
c01da712f6 docs: Move the bootloader size section into the Bootloader guide 2021-07-13 17:35:04 +10:00
morris
1560d6f1ba soc: add reset reasons in soc component 2021-07-13 10:45:38 +08:00
Dai Zi Yan
a68fd59b02 Merge branch 'docs/rename_ESP-MESH_to_ESP-WIFI-MESH' into 'master'
docs: rename ESP-MESH to ESP-WIFI-MESH

Closes DOC-7

See merge request espressif/esp-idf!14252
2021-07-13 02:23:43 +00:00
daiziyan
e95893bb1b docs: rename ESP-MESH to ESP-WIFI-MESH 2021-07-12 19:25:18 +08:00
Cao Sen Miao
fecf27e54c spi_flash: add support for 32Mbit address GD flash, for GD25Q256 2021-07-02 17:13:51 +08:00
Krzysztof Budzynski
4a87be3ecd Merge branch 'doc/add_esp32-s3-devkitc-1_user_guide_en' into 'master'
docs:add esp32-s3-devkitc-1 user guide

See merge request espressif/esp-idf!14096
2021-07-02 08:14:57 +00:00
Lv Xin Yue
faee145a61 docs:add esp32-s3-devkitc-1 user guide 2021-07-02 15:21:07 +08:00
Krzysztof Budzynski
22d4b24000 Merge branch 'docs/windows_installer_path_limitation' into 'master'
docs: add limitation of path lenght for Windows Installer

See merge request espressif/esp-idf!14194
2021-07-02 03:15:24 +00:00
Krzysztof Budzynski
f0b2926d70 Merge branch 'docs/s3_get_started' into 'master'
docs: updated getting started for S3

Closes IDF-3281 and IDF-3282

See merge request espressif/esp-idf!14174
2021-07-01 14:33:55 +00:00
Juraj Michálek
494dd6ea01 docs: add limitation of path lenght for Windows Installer 2021-07-01 12:29:37 +02:00
daiziyan
317ee67c2a docs: translate ESP32-S3 get started 2021-07-01 15:54:19 +08:00
Dai Zi Yan
5e5ddb1ffb docs:fixthe number of general purpose timers for ESP32-C3 2021-06-29 14:33:06 +08:00
Alexey Gerenkov
821869d98d apptrace: Refactors apptrace for better support various tracing HW 2021-06-24 13:16:13 +03:00
Marius Vikhammer
2b995a37eb docs: fix table in WifI guide not being rendered 2021-06-24 14:54:38 +08:00
Roland Dobai
b22fcbef96 Merge branch 'feature/drop_py2_support' into 'master'
Drop support for unsupported Python versions

Closes IDF-1676

See merge request espressif/esp-idf!13622
2021-06-22 09:28:49 +00:00
Krzysztof Budzynski
ed428ab811 Merge branch 'docs/windows_installer_2.9' into 'master'
docs: update Windows Tools 2.9 installation

See merge request espressif/esp-idf!14019
2021-06-22 03:27:18 +00:00
Roland Dobai
407053592e Drop support for unsupported Python versions 2021-06-21 21:48:49 +02:00
Juraj Michálek
bd749ad8be docs: update Windows Tools 2.9 installation 2021-06-21 14:19:40 +02:00
daiziyan
e1ad9a1d20 docs:update CN translation for fatal-errors, external-ram, and idf-monitor 2021-06-21 18:05:18 +08:00
Ivan Grokhotkov
c576c1414b Merge branch 'bugfix/fix-autocomplete-bash' into 'master'
Replaced broken link to shell autocompletion

See merge request espressif/esp-idf!13938
2021-06-18 10:24:00 +00:00
Wang Ning
2c31ac24c1 docs/add_how_to_debug_ota_failure_to_api_references 2021-06-16 19:28:01 +08:00
Ivan Grokhotkov
228fc04646 Merge branch 'example/ledc_pwm_basic' into 'master'
Example: Added LEDC basic PWM example

Closes DO-70

See merge request espressif/esp-idf!13114
2021-06-15 11:12:46 +00:00
Martin Gaňo
330d1cf2ae Fix autocomplete for bash 2021-06-11 01:59:36 +02:00
Marius Vikhammer
fbd6e9e320 docs: remove duplicate label 2021-06-09 09:30:42 +08:00
Marius Vikhammer
bdfda351bd build docs: enable building of S3 docs
* Added suport for building esp32s3 docs
 * Fixed all related warnings
 * Activated building of S3 docs for build HTML fast CI job
2021-06-09 09:30:36 +08:00
Krzysztof Budzynski
93334ea73a Merge branch 'docs/update_CN_trans_startup_debugging-example' into 'master'
docs:update CN translation for startup and debugging-example

See merge request espressif/esp-idf!13791
2021-06-08 07:09:27 +00:00
daiziyan
bb6a02ae53 docs:update CN translation for startup and debugging-example 2021-06-08 11:18:27 +08:00
Angus Gratton
dc6b950257 doc: Add performance guides for execuion speed, binary size, RAM usage
Closes https://github.com/espressif/esp-idf/issues/7007
Closes https://github.com/espressif/esp-idf/issues/6715
Closes https://github.com/espressif/esp-idf/issues/3781
Closes https://github.com/espressif/esp-idf/issues/2566
2021-06-03 13:55:34 +10:00
Marius Vikhammer
c7ead8cd73 docs: document contained an invalid character which couldnt be rendered in the PDF 2021-06-01 09:34:52 +08:00
Krzysztof Budzynski
c07f21a467 Merge branch 'doc/remove_modules_and_boards_section_from_hw_reference' into 'master'
remove modules and boards section

Closes DOC-45 and DOC-355

See merge request espressif/esp-idf!12846
2021-05-31 11:12:51 +00:00
Krzysztof Budzynski
997170ede1 Merge branch 'docs/introduce_new_rules_for_updating_docs' into 'master'
docs: introduce new rules for formatting documents

See merge request espressif/esp-idf!13642
2021-05-31 10:07:19 +00:00
Hao Ning
fc0eba4101 remove modules and boards section
doc: add redirections

docs: rebase master and add redirect links

docs: delete invalid links labeled in modules-and-boards

docs:installed pre-commit config

docs:retry

docs: separate links of modules and boards

docs: removed original files and added one more redirection

docs:deleted invalid links in jtag-debugging

docs:replaced old links in jtag-debugging

docs:fixd pipeline failures
2021-05-31 16:19:15 +08:00
daiziyan
8149eda0a9 docs: introduce new rules for writing documents 2021-05-31 10:56:18 +08:00
pedro.minatel
03cb5f8af8 Merge conflict fixed
Fixed the scale image on click to enlarge
2021-05-28 15:16:02 +01:00
Wang Ning
86a7d4c483 docs/update_strapping_pins_in_c3_devkit_user_guides 2021-05-28 03:56:22 +00:00
Marius Vikhammer
0c17973d54 docs: add rf calibration docs for S2 and C3 2021-05-26 10:09:50 +08:00
Krzysztof Budzynski
99e7aa1700 Merge branch 'docs/update_chip_comparsion_table' into 'master'
docs:translate chip series comparison table and update adc_types.h

Closes DOC-1278

See merge request espressif/esp-idf!13596
2021-05-25 10:44:01 +00:00
Wang Fang
71141a326d docs: clarified esp32 timer clk source, updated the flash encryption table and esptrace doc 2021-05-24 03:46:40 +00:00