zhangyanjiao
e04b4d9b81
modify API-reference using Sphinx directives
2022-07-01 17:39:53 +08:00
zhangyanjiao
254ec47ae4
update wifi api docs
2022-07-01 17:39:53 +08:00
Adam Múdry
12dfcdd1d9
spiffs: Add esp_spiffs_check() function
...
esp_spiffs_check() exposes SPIFFS_check() functionality to the user
2022-05-27 21:14:33 +00:00
Shang Zhou
e9e77e3598
docs: backport cn translation for mr16635
2022-03-14 11:36:43 +08:00
Shang Zhou
3c76a058aa
docs: update CN translation for MR15221 for v4.4
2022-01-27 08:27:04 +00:00
Darian Leung
65e9385d0a
docs: Update Power Management and Sleep Modes docs for ESP32-S3
2022-01-06 10:14:57 +08:00
weitianhua
8153b43705
Make ESP32 Bluetooth stack architecture Doc only visible for ESP32
2021-10-29 14:21:18 +08:00
weitianhua
f4aad85f8b
Make Classic BT related document links only visible for ESP32
2021-10-29 14:21:12 +08: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
Shang Zhou
3ffc5f0c67
docs:update CN translation for API reference storage(fatfs and index)
2021-10-15 18:59:22 +08: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
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
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
daiziyan
aca4a18c50
docs:update CN translation for bootloader, partition-tables, i2c, and ledc
2021-09-18 19:25:38 +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 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
intern
45925c28fd
docs: update translation for jtag-debugging/index.rst and power_management.rst
2021-08-26 12:21:19 +08: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
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
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
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
Dai Zi Yan
5e5ddb1ffb
docs:fixthe number of general purpose timers for ESP32-C3
2021-06-29 14:33:06 +08:00
daiziyan
e1ad9a1d20
docs:update CN translation for fatal-errors, external-ram, and idf-monitor
2021-06-21 18:05:18 +08: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
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
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
Angus Gratton
e14edecf5f
docs: Add random number generation to the API Reference System section
2021-05-18 16:05:42 +10:00
Angus Gratton
b7ad39f694
Merge branch 'bugfix/pthread_docs' into 'master'
...
Fix and improve pthread docs, create pthread example
Closes IDF-731 and IDFGH-5085
See merge request espressif/esp-idf!13314
2021-05-14 01:19:02 +00:00
Angus Gratton
e6d15a0975
docs: Rename esp_pthread docs to pthread, expand details of supported APIs
...
- Move the code that was in the document out to an example
2021-05-14 10:03:11 +10:00
Marius Vikhammer
fd477fa60e
docs: remove front page C3 docs not updated warning
2021-05-13 09:58:20 +08:00
pedro.minatel
a6798eac98
Added LEDC basic PWM example
...
Changes on the ledc_init function
Review on the README, docs and example functions
Added how to set freq and duty on README
Fix on the ledc.rst docs in the App Example
Added new example reference in the Chinese docs
2021-04-28 11:11:07 +01:00
Michael (XIAO Xufeng)
26585b4b4b
esp_flash: support override default chip driver list
2021-04-26 16:05:42 +08:00
Dai Zi Yan
4aa52da0c1
update CN translation for I2C
2021-04-22 16:05:01 +08:00
morris
75dfd970b4
dac: added DAC support macro
...
Remove DAC support on ESP32-S3
2021-04-12 12:04:46 +08:00
Krzysztof Budzynski
cb7de3659a
Merge branch 'bugfix/fix_timergroup_doc_unparsed_variable' into 'master'
...
doc: fix uninterpreted variables in timer.rst
Closes IDF-3064
See merge request espressif/esp-idf!13047
2021-04-12 00:38:53 +00:00
Angus Gratton
cef3b26a91
Merge branch 'refactor/move_from_esp_system' into 'master'
...
Movements from esp_system
Closes IDF-2165
See merge request espressif/esp-idf!12695
2021-04-08 10:16:08 +00:00
Michael (XIAO Xufeng)
925dacd7fb
Merge branch 'bugfix/remove_HSPI_macro_on_c3' into 'master'
...
spi: remove HSPI macros on esp32c3 and esp32s3
Closes IDF-2535
See merge request espressif/esp-idf!12637
2021-04-08 09:33:18 +00:00
Renz Bagaporo
c112bd8b57
esp_system: move intr_alloc
2021-04-07 17:53:37 +08:00