alex/esp-idf
alex/esp-idf
1
0
Fork 0
mirror of https://github.com/espressif/esp-idf.git synced 2024-10-05 20:47:46 -04:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity

Merge branch 'docs/remove_bt_doc_fillers_v4.4' into 'release/v4.4'

Browse Source 
docs: remove filler template content from BT docs (v4.4)

See merge request espressif/esp-idf!17947
This commit is contained in:
Marius Vikhammer 2022-04-27 20:35:06 +08:00
commit eff2402b5b
14 changed files with 4 additions and 128 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
docs/en/api-reference/bluetooth/controller_vhci.rst
View File

@ -1,13 +1,6 @@
Controller && VHCI Controller && VHCI
================== ==================
Overview
--------
`Instructions`_
.. _Instructions: ../template.html
Application Example Application Example
------------------- -------------------

7
docs/en/api-reference/bluetooth/esp_a2dp.rst
View File

@ -1,13 +1,6 @@
Bluetooth A2DP API Bluetooth A2DP API
================== ==================
Overview
--------
`Instructions`_
.. _Instructions: ../template.html
Application Example Application Example
------------------- -------------------

9
docs/en/api-reference/bluetooth/esp_avrc.rst
View File

@ -6,15 +6,6 @@ Overview
Bluetooth AVRCP reference APIs. Bluetooth AVRCP reference APIs.
`Instructions`_
Application Example
-------------------
`Instructions`_
.. _Instructions: ../template.html
API Reference API Reference
------------- -------------

13
docs/en/api-reference/bluetooth/esp_bt_defs.rst
View File

@ -1,19 +1,6 @@
BT GENERIC DEFINES BT GENERIC DEFINES
================== ==================
Overview
--------
`Instructions`_
Application Example
-------------------
`Instructions`_
.. _Instructions: ../template.html
API Reference API Reference
------------- -------------

9
docs/en/api-reference/bluetooth/esp_bt_device.rst
View File

@ -6,15 +6,6 @@ Overview
Bluetooth device reference APIs. Bluetooth device reference APIs.
`Instructions`_
Application Example
-------------------
`Instructions`_
.. _Instructions: ../template.html
API Reference API Reference
------------- -------------

13
docs/en/api-reference/bluetooth/esp_bt_main.rst
View File

@ -1,19 +1,6 @@
BT MAIN API BT MAIN API
=========== ===========
Overview
--------
`Instructions`_
Application Example
-------------------
`Instructions`_
.. _Instructions: ../template.html
API Reference API Reference
------------- -------------

9
docs/en/api-reference/bluetooth/esp_gap_ble.rst
View File

@ -1,13 +1,6 @@
GAP API GAP API
======= =======
Overview
--------
`Instructions`_
.. _Instructions: ../template.html
Application Example Application Example
------------------- -------------------
@ -18,7 +11,7 @@ Check :example:`bluetooth/bluedroid/ble` folder in ESP-IDF examples, which conta
- :example:`bluetooth/bluedroid/ble/gatt_security_client` - :example:`bluetooth/bluedroid/ble/gatt_security_client`
- :example_file:`GATT Security Client Example Walkthrough <bluetooth/bluedroid/ble/gatt_security_client/tutorial/Gatt_Security_Client_Example_Walkthrough.md>` - :example_file:`GATT Security Client Example Walkthrough <bluetooth/bluedroid/ble/gatt_security_client/tutorial/Gatt_Security_Client_Example_Walkthrough.md>`
* This is a SMP security server demo and its tutorial. This demo initiates its security parameters and acts as a GATT server, which can send a pair request to the peer device and then complete the encryption procedure. * This is a SMP security server demo and its tutorial. This demo initiates its security parameters and acts as a GATT server, which can send a pair request to the peer device and then complete the encryption procedure.
- :example:`bluetooth/bluedroid/ble/gatt_security_server` - :example:`bluetooth/bluedroid/ble/gatt_security_server`
- :example_file:`GATT Security Server Example Walkthrough <bluetooth/bluedroid/ble/gatt_security_server/tutorial/Gatt_Security_Server_Example_Walkthrough.md>` - :example_file:`GATT Security Server Example Walkthrough <bluetooth/bluedroid/ble/gatt_security_server/tutorial/Gatt_Security_Server_Example_Walkthrough.md>`

12
docs/en/api-reference/bluetooth/esp_gap_bt.rst
View File

@ -1,18 +1,6 @@
CLASSIC BLUETOOTH GAP API CLASSIC BLUETOOTH GAP API
========================= =========================
Overview
--------
`Instructions`_
Application Example
-------------------
`Instructions`_
.. _Instructions: ../template.html
API Reference API Reference
------------- -------------

12
docs/en/api-reference/bluetooth/esp_gatt_defs.rst
View File

@ -1,18 +1,6 @@
GATT DEFINES GATT DEFINES
============ ============
Overview
--------
`Instructions`_
Application Example
-------------------
`Instructions`_
.. _Instructions: ../template.html
API Reference API Reference
------------- -------------

11
docs/en/api-reference/bluetooth/esp_gattc.rst
View File

@ -1,24 +1,17 @@
GATT CLIENT API GATT CLIENT API
=============== ===============
Overview
--------
`Instructions`_
.. _Instructions: ../template.html
Application Example Application Example
------------------- -------------------
Check :example:`bluetooth/bluedroid/ble` folder in ESP-IDF examples, which contains the following demos and their tutorials: Check :example:`bluetooth/bluedroid/ble` folder in ESP-IDF examples, which contains the following demos and their tutorials:
* This is a GATT client demo and its tutorial. This demo can scan for devices, connect to the GATT server and discover its services. * This is a GATT client demo and its tutorial. This demo can scan for devices, connect to the GATT server and discover its services.
- :example:`bluetooth/bluedroid/ble/gatt_client` - :example:`bluetooth/bluedroid/ble/gatt_client`
- :example_file:`GATT Client Example Walkthrough <bluetooth/bluedroid/ble/gatt_client/tutorial/Gatt_Client_Example_Walkthrough.md>` - :example_file:`GATT Client Example Walkthrough <bluetooth/bluedroid/ble/gatt_client/tutorial/Gatt_Client_Example_Walkthrough.md>`
* This is a multiple connection demo and its tutorial. This demo can connect to multiple GATT server devices and discover their services. * This is a multiple connection demo and its tutorial. This demo can connect to multiple GATT server devices and discover their services.
- :example:`bluetooth/bluedroid/ble/gattc_multi_connect` - :example:`bluetooth/bluedroid/ble/gattc_multi_connect`
- :example_file:`GATT Client Multi-connection Example Walkthrough <bluetooth/bluedroid/ble/gattc_multi_connect/tutorial/Gatt_Client_Multi_Connection_Example_Walkthrough.md>` - :example_file:`GATT Client Multi-connection Example Walkthrough <bluetooth/bluedroid/ble/gattc_multi_connect/tutorial/Gatt_Client_Multi_Connection_Example_Walkthrough.md>`

9
docs/en/api-reference/bluetooth/esp_gatts.rst
View File

@ -1,19 +1,12 @@
GATT SERVER API GATT SERVER API
=============== ===============
Overview
--------
`Instructions`_
.. _Instructions: ../template.html
Application Example Application Example
------------------- -------------------
Check :example:`bluetooth/bluedroid/ble` folder in ESP-IDF examples, which contains the following demos and their tutorials: Check :example:`bluetooth/bluedroid/ble` folder in ESP-IDF examples, which contains the following demos and their tutorials:
* This is a GATT sever demo and its tutorial. This demo creates a GATT service with an attribute table, which releases the user from adding attributes one by one. This is the recommended method of adding attributes. * This is a GATT sever demo and its tutorial. This demo creates a GATT service with an attribute table, which releases the user from adding attributes one by one. This is the recommended method of adding attributes.
- :example:`bluetooth/bluedroid/ble/gatt_server_service_table` - :example:`bluetooth/bluedroid/ble/gatt_server_service_table`
- :example_file:`GATT Server Service Table Example Walkthrough <bluetooth/bluedroid/ble/gatt_server_service_table/tutorial/Gatt_Server_Service_Table_Example_Walkthrough.md>` - :example_file:`GATT Server Service Table Example Walkthrough <bluetooth/bluedroid/ble/gatt_server_service_table/tutorial/Gatt_Server_Service_Table_Example_Walkthrough.md>`

7
docs/en/api-reference/bluetooth/esp_hf_client.rst
View File

@ -1,13 +1,6 @@
HFP CLIENT API HFP CLIENT API
============== ==============
Overview
--------
`Instructions`_
.. _Instructions: ../template.html
API Reference API Reference
------------- -------------

7
docs/en/api-reference/bluetooth/esp_hf_defs.rst
View File

@ -1,13 +1,6 @@
HFP DEFINES HFP DEFINES
=========== ===========
Overview
--------
`Instructions`_
.. _Instructions: ../template.html
API Reference API Reference
------------- -------------

7
docs/en/api-reference/bluetooth/esp_spp.rst
View File

@ -1,13 +1,6 @@
SPP API SPP API
=============== ===============
Overview
--------
`Instructions`_
.. _Instructions: ../template.html
Application Example Application Example
------------------- -------------------