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
morris
dce0993ce5
doc: apply wavedrom extension
2022-05-01 22:58:19 +08:00
wangmengyang
0760a969a8
component/docs: enable generation of API-reference documents for Bluetooth HID device
2022-04-11 02:50:50 +00:00
xiongweichao
6514f9e94c
docs: translate coexist from CN to EN
2022-03-09 02:50:00 +00:00
Sudeep Mohanty
4067bc40fc
docs: Updated ULP documentation
...
This commit updates documentation for ULP.
2022-03-01 09:02:41 +05:30
Sudeep Mohanty
4d8a0cce29
ulp: Added support for ULP FSM on esp32s3 and fixed bugs for esp32s2
...
This commit enables ULP FSM support for esp32s3 and updates ULP FSM code
flow for other chips.
It adds C Macro support for the ULP FSM instruction set on esp32s2 and
esp32s3.
The unit tests are also updated to test ULP FSM on ep32s2 and esp32s3.
2022-02-22 12:25:57 +05:30
Marius Vikhammer
6d50a8dd7a
docs: remove peripherals that are not supported from C2 docs
2022-02-16 10:22:46 +08:00
Marius Vikhammer
f018d3f2f0
docs: update esp-docs, rename esp8684 to esp32c2
2022-01-21 09:26:35 +08:00
Marius Vikhammer
3e56ba05cc
docs: fix missing static file path
...
Also update layout of version table
2021-12-29 13:57:30 +08:00
Marius Vikhammer
82325f6037
docs: update docs to be able to build with esp8684
2021-12-20 10:32:49 +08:00
Krzysztof Budzynski
75d9df0285
Merge branch 'bugfix/html_redirect' into 'master'
...
docs: fix html redirects not working
See merge request espressif/esp-idf!15928
2021-12-06 03:57:33 +00:00
Marius Vikhammer
85e509eb6b
docs: fix html redirects not working
...
HTML redirects for docs broke during migration to esp-docs.
2021-11-12 17:20:03 +08:00
Roland Dobai
9c1d4f5b54
Build & config: Remove the "make" build system
...
The "make" build system was deprecated in v4.0 in favor of idf.py
(cmake). The remaining support is removed in v5.0.
2021-11-10 09:53:53 +01:00
Wei Tian Hua
347e04cf73
Merge branch 'doc/make_classic_bt_API_ref_only_for_esp32' into 'master'
...
Doc/Make Classic BT related document links only visible for ESP32
Closes IDFGH-5008, IDFGH-6022, and AUD-3378
See merge request espressif/esp-idf!15635
2021-10-29 02:27:24 +00:00
weitianhua
64aa94d823
Make Classic BT related document links only visible for ESP32
2021-10-27 15:28:47 +08:00
Armando
d41da2792a
doc: add flash and psram configuration doc in programming guide
2021-10-26 11:49:36 +08:00
Marius Vikhammer
1cf61c849f
docs: enable publishing of S3 docs
2021-09-06 09:11:17 +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
Marius Vikhammer
8b38e9ecf5
docs: fix edit on github link to point to esp-idf
...
Also add check for IDF_PATH for better error feedback
2021-08-24 17:54:48 +08:00
Marius Vikhammer
7411321603
docs: update to use esp-docs
2021-08-24 08:56:48 +08:00
Jakob Hasse
1c3be690ed
[esp_hw_support]: HMAC upstream support for S3
2021-08-13 12:01:06 +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
Lv Xin Yue
faee145a61
docs:add esp32-s3-devkitc-1 user guide
2021-07-02 15:21:07 +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
Marius Vikhammer
0c17973d54
docs: add rf calibration docs for S2 and C3
2021-05-26 10:09:50 +08:00
Jeroen Domburg
2c75f63f89
* ets_delay_us(1) has too much overhead; change logic
...
* Fix MR comments
2021-04-28 16:38:24 +08:00
Krzysztof Budzynski
632b5c40e6
Revert "Merge branch 'doc/use_sphinx_reredirect_extension' into 'master'"
...
This reverts merge request !13293
2021-04-23 13:44:40 +08:00
Krzysztof Budzynski
3e94dce15e
Merge branch 'doc/use_sphinx_reredirect_extension' into 'master'
...
Doc: Sphinx uses the sphinx-reredirect extension
See merge request espressif/esp-idf!13293
2021-04-23 05:13:37 +00:00
Darian Leung
2be772af1c
Sphinx uses reredirect extension
...
This commit removes the custom HTML rediiect extension and uses
the sphinx-reredirect extension instead. The sphinx-reredirect
extension allows for redirection to external links as well as
support for wildcards.
2021-04-23 00:02:30 +08:00
Roland Dobai
a2cf1a7d38
docs: Update JTAG debugging guides for ESP32-C3
2021-04-13 12:48:50 +02:00
morris
75dfd970b4
dac: added DAC support macro
...
Remove DAC support on ESP32-S3
2021-04-12 12:04:46 +08:00
Marius Vikhammer
0633ee3e18
docs: fix doxygen compile warnings for doxygen 1.9.1
...
Newer versions of doxygen will give warnings for comments in
INPUT lists
Delete all comment lines to fix these warnings, our folder structure
stil gives an OK overview of what we are including
2021-04-09 11:57:03 +08:00
Marius Vikhammer
440fab3d6e
docs: add google analytics tracking
2021-04-06 11:56:11 +08:00
Marius Vikhammer
91439e3818
docs: updated system api-reference chapters for C3
2021-03-15 18:51:12 +08:00
Marius Vikhammer
6334b5e56f
docs: update api-reference chapters for C3
...
Checked and updated the following chapters:
* api-reference/network
* api-reference/protocols
* api-reference/provisioning
* api-reference/storage
* api-reference/peripherals/ds
* api-reference/peripherals/hmac
* api-reference/peripherals/secure_element
2021-03-01 14:58:08 +08:00
Kang Zuoling
78a1cd3643
touch_element: add touch element api-reference doc
2021-02-22 12:16:49 +08:00
Wang Ning
aa2b3e1b01
Add ESP32-C3-DevKitM-1 User Guide and updated ESP32C3_DOCS
2021-02-05 12:08:21 +08:00
Marius Vikhammer
548fd02d10
docs: initial update of programming guide for C3
...
Updates "front page" content, get-started, and api-guides with C3 content
Enable building and publishing of C3 docs in CI
2021-02-01 15:40:02 +08:00
kirill.chalov
f634c59289
Add hypertargets to all TRM references
2021-01-26 05:51:52 +00:00
Marius Vikhammer
da947d736f
Docs: Add C3 support to build_docs
2020-12-28 12:25:03 +08:00
Krzysztof
1c184bd0be
docs: ESP-IDF v4.2 fully supports ESP32-S2, remove documentation that describe preview support
2020-12-03 16:21:16 +08:00
morris
91cf7cc58d
doc: dedicated gpio api reference
2020-10-20 21:06:10 +08:00
martin.gano
7a9abe3ec5
add chart of version support to version.rst
2020-09-09 11:32:44 +02:00
Andrei Gramakov
c863b4c777
docs: tinyusb documentation
2020-08-27 13:49:33 +02:00
kirill.chalov
954d55bad0
Docs: Add copybutton package to conf_common.py
2020-08-27 02:48:43 +00:00
morris
b30bd7a2ef
esp32s2: add CP_DMA driver
2020-08-04 15:28:32 +08:00
Angus Gratton
a2dc60b254
Merge branch 'feature/secure_boot_esp32s2' into 'master'
...
Feature/secure boot esp32s2
See merge request espressif/esp-idf!8254
2020-07-28 16:39:34 +08:00
Supreet Deshpande
33979a9361
Docs: Secure boot v2 support for ESP32-S2
2020-07-27 00:01:10 +00:00
Ivan Grokhotkov
962ea8b9f2
docs: repurpose WROVER-KIT debugging guide for Kaluga-1
2020-07-24 15:54:47 +02:00
Felipe Neves
b6dba84323
ulp: added support to building code for riscv ULP coprocessor
2020-07-15 15:28:49 -03:00
Michael (XIAO Xufeng)
f6dd63d03d
spi_slave_hd: new driver for spi slave in half duplex mode
2020-07-11 00:00:50 +08:00
Ivan Grokhotkov
5985c07ab7
docs: add section about USB CDC console
2020-06-26 15:38:49 +02:00
Angus Gratton
7d989e08fd
doc: Fix passing of build macros to Doxygen
...
Regression in fbb54184ef
, the dictionary
passed to generate_doxygen function was still the project_description
structure.
2020-06-12 14:30:47 +10:00
Jakob Hasse
516680a4ff
Doc: DS documentation for S2
2020-06-04 10:49:22 +08:00
Marius Vikhammer
67ea59d605
docs: fix check_docs not working for multiple builders
...
When building docs with multiple builders the warning logs are now checked after
each run. Solves the issue where the logs would be overwritten by next builder before checking.
Closes IDF-1659
2020-05-29 20:10:18 +08:00
Krzysztof Budzynski
fa0dd5cc7b
Merge branch 'doc/view_github_link' into 'master'
...
docs: add 'edit-on-github' link to html theme
Closes IDF-1504
See merge request espressif/esp-idf!8629
2020-05-25 03:21:23 +08:00
Krzysztof Budzynski
6048791a1b
Merge branch 'feature/doc_build_subset' into 'master'
...
docs: support building a subset of the documentation with build_docs
Closes IDF-1688
See merge request espressif/esp-idf!8857
2020-05-25 02:58:28 +08:00
Marius Vikhammer
a316082f53
docs: support building a subset of the documentation with build_docs
...
Closes IDF-1688
2020-05-22 15:01:40 +08:00
Mahavir Jain
6272cb842f
Merge branch 'feature/esp_wroom32_se_example' into 'master'
...
Feature/esp wroom32 se example
See merge request espressif/esp-idf!8552
2020-05-21 19:51:19 +08:00