From 18c704014f4b001097cff8581fec7eaae7f0c9f6 Mon Sep 17 00:00:00 2001 From: Marius Vikhammer Date: Wed, 27 Apr 2022 14:44:36 +0800 Subject: [PATCH] docs: remove filler template content from BT docs --- docs/en/api-reference/bluetooth/controller_vhci.rst | 7 ------- docs/en/api-reference/bluetooth/esp_a2dp.rst | 7 ------- docs/en/api-reference/bluetooth/esp_avrc.rst | 9 --------- docs/en/api-reference/bluetooth/esp_bt_defs.rst | 13 ------------- docs/en/api-reference/bluetooth/esp_bt_device.rst | 9 --------- docs/en/api-reference/bluetooth/esp_bt_main.rst | 13 ------------- docs/en/api-reference/bluetooth/esp_gap_ble.rst | 9 +-------- docs/en/api-reference/bluetooth/esp_gap_bt.rst | 12 ------------ docs/en/api-reference/bluetooth/esp_gatt_defs.rst | 12 ------------ docs/en/api-reference/bluetooth/esp_gattc.rst | 11 ++--------- docs/en/api-reference/bluetooth/esp_gatts.rst | 9 +-------- docs/en/api-reference/bluetooth/esp_hf_client.rst | 7 ------- docs/en/api-reference/bluetooth/esp_hf_defs.rst | 7 ------- docs/en/api-reference/bluetooth/esp_spp.rst | 7 ------- 14 files changed, 4 insertions(+), 128 deletions(-) diff --git a/docs/en/api-reference/bluetooth/controller_vhci.rst b/docs/en/api-reference/bluetooth/controller_vhci.rst index 22fb3f7903..6fc65df497 100644 --- a/docs/en/api-reference/bluetooth/controller_vhci.rst +++ b/docs/en/api-reference/bluetooth/controller_vhci.rst @@ -1,13 +1,6 @@ Controller && VHCI ================== -Overview --------- - -`Instructions`_ - -.. _Instructions: ../template.html - Application Example ------------------- diff --git a/docs/en/api-reference/bluetooth/esp_a2dp.rst b/docs/en/api-reference/bluetooth/esp_a2dp.rst index 8dea862fc1..e3b5c51166 100644 --- a/docs/en/api-reference/bluetooth/esp_a2dp.rst +++ b/docs/en/api-reference/bluetooth/esp_a2dp.rst @@ -1,13 +1,6 @@ Bluetooth A2DP API ================== -Overview --------- - -`Instructions`_ - -.. _Instructions: ../template.html - Application Example ------------------- diff --git a/docs/en/api-reference/bluetooth/esp_avrc.rst b/docs/en/api-reference/bluetooth/esp_avrc.rst index 1c15c7b69c..7b8fa6f6e9 100644 --- a/docs/en/api-reference/bluetooth/esp_avrc.rst +++ b/docs/en/api-reference/bluetooth/esp_avrc.rst @@ -6,15 +6,6 @@ Overview Bluetooth AVRCP reference APIs. -`Instructions`_ - -Application Example -------------------- - -`Instructions`_ - -.. _Instructions: ../template.html - API Reference ------------- diff --git a/docs/en/api-reference/bluetooth/esp_bt_defs.rst b/docs/en/api-reference/bluetooth/esp_bt_defs.rst index 85e73d0688..58400242ce 100644 --- a/docs/en/api-reference/bluetooth/esp_bt_defs.rst +++ b/docs/en/api-reference/bluetooth/esp_bt_defs.rst @@ -1,19 +1,6 @@ BT GENERIC DEFINES ================== -Overview --------- - -`Instructions`_ - -Application Example -------------------- - -`Instructions`_ - -.. _Instructions: ../template.html - - API Reference ------------- diff --git a/docs/en/api-reference/bluetooth/esp_bt_device.rst b/docs/en/api-reference/bluetooth/esp_bt_device.rst index b234cea14c..d135e21340 100644 --- a/docs/en/api-reference/bluetooth/esp_bt_device.rst +++ b/docs/en/api-reference/bluetooth/esp_bt_device.rst @@ -6,15 +6,6 @@ Overview Bluetooth device reference APIs. -`Instructions`_ - -Application Example -------------------- - -`Instructions`_ - -.. _Instructions: ../template.html - API Reference ------------- diff --git a/docs/en/api-reference/bluetooth/esp_bt_main.rst b/docs/en/api-reference/bluetooth/esp_bt_main.rst index 321f9331e2..2955ee57d0 100644 --- a/docs/en/api-reference/bluetooth/esp_bt_main.rst +++ b/docs/en/api-reference/bluetooth/esp_bt_main.rst @@ -1,19 +1,6 @@ BT MAIN API =========== -Overview --------- - -`Instructions`_ - -Application Example -------------------- - -`Instructions`_ - -.. _Instructions: ../template.html - - API Reference ------------- diff --git a/docs/en/api-reference/bluetooth/esp_gap_ble.rst b/docs/en/api-reference/bluetooth/esp_gap_ble.rst index 8f95906853..8d539dfdcc 100644 --- a/docs/en/api-reference/bluetooth/esp_gap_ble.rst +++ b/docs/en/api-reference/bluetooth/esp_gap_ble.rst @@ -1,13 +1,6 @@ GAP API ======= -Overview --------- - -`Instructions`_ - -.. _Instructions: ../template.html - 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_file:`GATT Security Client Example Walkthrough ` -* 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_file:`GATT Security Server Example Walkthrough ` diff --git a/docs/en/api-reference/bluetooth/esp_gap_bt.rst b/docs/en/api-reference/bluetooth/esp_gap_bt.rst index 346f7ec90a..1466f6b766 100644 --- a/docs/en/api-reference/bluetooth/esp_gap_bt.rst +++ b/docs/en/api-reference/bluetooth/esp_gap_bt.rst @@ -1,18 +1,6 @@ CLASSIC BLUETOOTH GAP API ========================= -Overview --------- - -`Instructions`_ - -Application Example -------------------- - -`Instructions`_ - -.. _Instructions: ../template.html - API Reference ------------- diff --git a/docs/en/api-reference/bluetooth/esp_gatt_defs.rst b/docs/en/api-reference/bluetooth/esp_gatt_defs.rst index 931802126f..8b6a31ba57 100644 --- a/docs/en/api-reference/bluetooth/esp_gatt_defs.rst +++ b/docs/en/api-reference/bluetooth/esp_gatt_defs.rst @@ -1,18 +1,6 @@ GATT DEFINES ============ -Overview --------- - -`Instructions`_ - -Application Example -------------------- - -`Instructions`_ - -.. _Instructions: ../template.html - API Reference ------------- diff --git a/docs/en/api-reference/bluetooth/esp_gattc.rst b/docs/en/api-reference/bluetooth/esp_gattc.rst index 708888d2b5..bb511d196f 100644 --- a/docs/en/api-reference/bluetooth/esp_gattc.rst +++ b/docs/en/api-reference/bluetooth/esp_gattc.rst @@ -1,24 +1,17 @@ GATT CLIENT API =============== -Overview --------- - -`Instructions`_ - -.. _Instructions: ../template.html - Application Example ------------------- 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_file:`GATT Client Example Walkthrough ` -* 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_file:`GATT Client Multi-connection Example Walkthrough ` diff --git a/docs/en/api-reference/bluetooth/esp_gatts.rst b/docs/en/api-reference/bluetooth/esp_gatts.rst index 1b48fccc89..eb58060cbf 100644 --- a/docs/en/api-reference/bluetooth/esp_gatts.rst +++ b/docs/en/api-reference/bluetooth/esp_gatts.rst @@ -1,19 +1,12 @@ GATT SERVER API =============== -Overview --------- - -`Instructions`_ - -.. _Instructions: ../template.html - Application Example ------------------- 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_file:`GATT Server Service Table Example Walkthrough ` diff --git a/docs/en/api-reference/bluetooth/esp_hf_client.rst b/docs/en/api-reference/bluetooth/esp_hf_client.rst index b79eb743f7..2a3f6d57a9 100644 --- a/docs/en/api-reference/bluetooth/esp_hf_client.rst +++ b/docs/en/api-reference/bluetooth/esp_hf_client.rst @@ -1,13 +1,6 @@ HFP CLIENT API ============== -Overview --------- - -`Instructions`_ - -.. _Instructions: ../template.html - API Reference ------------- diff --git a/docs/en/api-reference/bluetooth/esp_hf_defs.rst b/docs/en/api-reference/bluetooth/esp_hf_defs.rst index 4633a81f67..09152f3df6 100644 --- a/docs/en/api-reference/bluetooth/esp_hf_defs.rst +++ b/docs/en/api-reference/bluetooth/esp_hf_defs.rst @@ -1,13 +1,6 @@ HFP DEFINES =========== -Overview --------- - -`Instructions`_ - -.. _Instructions: ../template.html - API Reference ------------- diff --git a/docs/en/api-reference/bluetooth/esp_spp.rst b/docs/en/api-reference/bluetooth/esp_spp.rst index ced5340899..51ceadd507 100644 --- a/docs/en/api-reference/bluetooth/esp_spp.rst +++ b/docs/en/api-reference/bluetooth/esp_spp.rst @@ -1,13 +1,6 @@ SPP API =============== -Overview --------- - -`Instructions`_ - -.. _Instructions: ../template.html - Application Example -------------------