Marius Vikhammer
cff4d95568
docs(programming_guide): turned off smartquotes
...
Sphinx would "smartly" format e.g. double dashes into typographically correct entities,
i.e. a long dash unicode character.
This doesnt always work well for our docs were sometimes a double dash could be a python
argument, which when copied would no longer work.
2023-12-20 13:09:17 +08:00
Jiang Jiang Jian
f04854bb4a
Merge branch 'docs/update_nan_docs_v5.2' into 'release/v5.2'
...
Fix inconsistency in NAN documentation (Backport v5.2)
See merge request espressif/esp-idf!27267
2023-11-21 11:48:31 +08:00
Shyamal Khachane
782eaa3c7e
docs(esp_wifi): Fix inconsistency in NAN documentation
2023-11-20 15:07:45 +05:30
Mahavir Jain
2882b6f68b
docs: add ECDSA peripheral chapter for H2/P4
...
- Add ECDSA peripheral chapter and instructions to program efuse key block
- Update security guide for ECDSA peripheral mention for device identity
- Link with ESP-TLS guide about using ECDSA peripheral in TLS connection
2023-11-17 07:13:53 +00:00
Armando
70314b56d5
feat(sdmmc): supported sd2.0 on esp32p4
2023-10-18 11:57:55 +00:00
Marius Vikhammer
d27dd4d9cb
Merge branch 'docs/show_include_path' into 'master'
...
docs: show include path and require component as part of API header
Closes IDF-3134, DOC-1032, and DOC-3629
See merge request espressif/esp-idf!25092
2023-10-11 09:36:14 +08:00
Marius Vikhammer
ebe68c3ee3
docs(build): add header include path and component require to api reference
2023-10-07 11:47:45 +08:00
Armando
4215adcdb4
feat(cache): added cache msync doc
2023-09-28 15:53:19 +08:00
xuxiao
4701aa1589
feat(doc): update wifi sections for H2
2023-08-31 19:27:51 +08:00
Yi Ying
d8b34c739a
Merge branch 'docs/add_bluetooth_overview_page' into 'master'
...
docs: add bluetooth overview
Closes DOC-5644
See merge request espressif/esp-idf!25030
2023-08-16 19:02:16 +08:00
Marius Vikhammer
27baef2424
docs(esp32p4): added building docs for ESP32-P4
2023-08-16 10:13:47 +08:00
Yi Ying
eafbd37e8f
docs (Bluetooth): add bluetooth overview document
2023-08-15 11:13:14 +08:00
wangmengyang
d4ac2380e7
component/docs: enable generation of API-reference documents for Bluetooth HID host
2023-06-21 12:02:58 +08:00
Marius Vikhammer
d19600e0a7
ulp/lp-core: added docs describing the lp core
2023-06-06 17:42:03 +08:00
xuxiao
843107e9d6
docs: update esp32c6 api guides about wifi part
2023-05-31 15:20:40 +08:00
Marius Vikhammer
3da38a603a
docs: updated misc C6 programming guide docs with minor changes.
2023-05-31 11:17:24 +08:00
Shen Weilong
2900ed4858
ble docs: Update the ble docs for esp32c6 and esp32h2
2023-05-19 11:01:11 +08:00
Marius Vikhammer
359b237cc5
ulp: added sleep support for lp core
...
Added support for running LP core while hp core sleeps, as well
as waking up the hp core.
2023-04-25 11:51:35 +08:00
laokaiyao
53584bb5a7
ana_cmpr: add programming guide
2023-03-17 14:35:55 +08:00
Marius Vikhammer
24e0d91cd0
docs: fix broken links
2023-03-06 17:29:10 +08:00
morris
a7f5ff32ff
doc: initial parallel IO programming guide
...
Also correct the GPIO information on esp32h2.
2023-03-01 00:43:14 +00:00
Darian Leung
a57496acfe
usb_host: Add maintainer's notes (Design, Architecture)
...
This commit adds some parts of the USB Host Stack's maintainers notes
(specifically "Design" and "Architecture").
2023-01-24 02:49:35 +08:00
Armando
e80e1450ac
sdio: c6 doc update
2023-01-18 02:34:46 +00:00
Marius Vikhammer
fd4cadd8a1
docs: ignore xtensa isa-summary during linkcheck
2023-01-17 12:53:38 +08:00
Marius Vikhammer
70d1dbccd8
Merge branch 'docs/enable_h2_build' into 'master'
...
docs: add support for building H2 docs
Closes IDF-6259
See merge request espressif/esp-idf!21933
2023-01-17 12:11:29 +08:00
Marius Vikhammer
7100b7d1ff
docs: add support for building H2 docs
2023-01-17 10:04:26 +08:00
Darian Leung
a52aff81a8
usb_host: Add maintainer's notes (Introduction and DWC_OTG Controller)
...
This commit adds some parts of the USB Host Stack's maintainers notes
(specifically "Introduction" and "DWC_OTG Controller" chapters).
2023-01-13 20:00:18 +08:00
wuzhenghui
5822cdf93b
esp_phy: enable for esp32c6
2022-12-16 15:47:56 +08:00
morris
4019e307f1
doc: add api reference for etm driver
2022-11-23 15:32:34 +08:00
Wang Ning
b757eb6ce4
Docs: Update folder structure for 5.1 migration
2022-10-25 15:16:27 +08:00
Marius Vikhammer
ca4ad3ce7c
docs: add support for building C6 docs
2022-10-13 04:39:16 +00:00
Alexey Lapshin
e6f7b1a3a0
tools: cmake: check tool supported version with idf_tools.py
2022-10-03 19:01:32 +04:00
wangjialiang
6e79d05814
ble_mesh: docs: Remove BLE Mesh related reference for C2
2022-09-16 19:39:51 +08:00
Alexey Lapshin
8abef173a1
docs: update link for ESP ROM ELF releases
2022-09-01 15:05:26 +04:00
Zim Kalinowski
e80d4c8f76
Merge branch 'docs/update_linkcheck_ignore_c2' into 'master'
...
docs: remove C2 datasheet from link check ignore
Closes IDF-4950
See merge request espressif/esp-idf!19514
2022-08-21 16:28:31 +08:00
Marius Vikhammer
8b756f071c
docs: remove C2 datasheet from link check ignore
2022-08-11 18:08:00 +08:00
Geng Yuchao
f070ac4da8
Update BLE documentation scope
2022-08-08 20:51:58 +08:00
Geng Yuchao
0a1d8c1e09
Fix soc caps define for all chips
2022-08-08 20:50:28 +08:00
morris
741b031e83
soc: added SOC_TOUCH_SENSE_SUPPORTED macro
2022-07-22 00:12:36 +00:00
morris
75d411a003
doc: update sdm api reference
2022-07-20 14:59:50 +08:00
Wang Ning
394a195015
Merge branch 'docs/restructure_migration_guide' into 'master'
...
Docs/Restructure Migration Guides
See merge request espressif/esp-idf!18920
2022-07-19 23:15:07 +08:00
Wang Ning
4526a5abf5
docs/restructure_migration_guides
2022-07-19 18:54:51 +08:00
Armando
5b523a3313
esp_adc: new esp_adc component and adc drivers
2022-07-15 18:31:00 +08:00
Marius Vikhammer
d62421619c
docs: update system API-guides for ESP32-C2
2022-07-12 09:32:43 +08:00
Mu Hai Dong
eb4421bf33
doc: esp32c2 wifi programming guide doc.
2022-07-07 14:13:11 +08:00
Darian Leung
c2e098c10e
bluedroid: Fix breaking change typos
...
This commit fixes typos that are breaking changes (i.e., macros, types, and functions)
in the bluedroid API. Migration notes for v5.0 have also been added.
Closes https://github.com/espressif/esp-idf/issues/6887
2022-06-21 19:07:25 +08:00
wangmengyang
1423d02cb0
Added BT_SDP API reference document
2022-05-28 23:34:21 +00:00
xiongweichao
b2987c1e94
Added BT_L2CAP API reference document
2022-05-28 23:34:21 +00:00
Marius Vikhammer
5aa01cb80e
docs: update linkcheck configs
...
linkcheck CI job can now pass, no longer necessary to ignore the results from it.
2022-05-07 13:09:41 +08:00
Jiang Jiang Jian
34211f898c
Merge branch 'docs/update_esp_hid_device' into 'master'
...
[docs] fix documents for Bluetooth HID Device API reference and example
See merge request espressif/esp-idf!17558
2022-05-05 23:58:07 +08:00
