From 03c14809f96d43352e76c4e3282b8ed6bd70b412 Mon Sep 17 00:00:00 2001 From: krzychb Date: Tue, 17 Jan 2017 20:03:26 +0100 Subject: [PATCH] Updated links to point directly to example folder, fixed names --- docs/api/bluetooth/controller_vhci.rst | 10 ++++------ docs/api/bluetooth/esp_blufi.rst | 6 +++--- docs/api/bluetooth/esp_gap_ble.rst | 16 ++++++---------- docs/api/bluetooth/esp_gattc.rst | 12 +++++------- docs/api/bluetooth/esp_gatts.rst | 13 +++++-------- docs/api/storage/nvs_flash.rst | 6 +++--- 6 files changed, 26 insertions(+), 37 deletions(-) diff --git a/docs/api/bluetooth/controller_vhci.rst b/docs/api/bluetooth/controller_vhci.rst index 3868d9cec7..dfad1af25e 100644 --- a/docs/api/bluetooth/controller_vhci.rst +++ b/docs/api/bluetooth/controller_vhci.rst @@ -6,19 +6,17 @@ Overview `Instructions`_ +.. _Instructions: ../template.html + Application Example ------------------- -Check `/examples `_ folder of `espressif/esp-idf `_ repository, that contains the following example: +Check `/examples/bluetooth `_ folder of `espressif/esp-idf `_ repository, that contains the following example: -`bluetooth/ble_adv `_ +`ble_adv `_ This is a BLE advertising demo with virtual HCI interface. Send Reset/ADV_PARAM/ADV_DATA/ADV_ENABLE HCI command for BLE advertising. -`Instructions`_ - -.. _Instructions: ../template.html - API Reference ------------- diff --git a/docs/api/bluetooth/esp_blufi.rst b/docs/api/bluetooth/esp_blufi.rst index a281c3d3d6..442e54f5ca 100644 --- a/docs/api/bluetooth/esp_blufi.rst +++ b/docs/api/bluetooth/esp_blufi.rst @@ -11,11 +11,11 @@ Use should concern these things: Application Example ------------------- -Check `/examples `_ folder of `espressif/esp-idf `_ repository, that contains the following example: +Check `/examples/bluetooth `_ folder of `espressif/esp-idf `_ repository, that contains the following example: -`bluetooth/blufi `_ +`blufi `_ -This is a BLUFI demo. This demo can set ESP32's wifi to softap/station/softap&station mode and config wifi connections. + This is a BLUFI demo. This demo can set ESP32's wifi to softap/station/softap&station mode and config wifi connections. API Reference diff --git a/docs/api/bluetooth/esp_gap_ble.rst b/docs/api/bluetooth/esp_gap_ble.rst index 40ccdba50f..f53b8d56ad 100644 --- a/docs/api/bluetooth/esp_gap_ble.rst +++ b/docs/api/bluetooth/esp_gap_ble.rst @@ -1,25 +1,21 @@ GAP API -======== +======= Overview -------- `Instructions`_ +.. _Instructions: ../template.html + Application Example ------------------- -Check `/examples `_ folder of `espressif/esp-idf `_ repository, that contains the following example: - -`14_gatts_demo `_ -`15_gattc_demo `_ - -The two demos use different gap api, such like advertising, scan, set device name and others. +Check `/examples/bluetooth `_ folder of `espressif/esp-idf `_ repository, that contains the following examples: -`Instructions`_ - -.. _Instructions: ../template.html +`gatt_server `_, `gatt_client `_ + The two demos use different gap api, such like advertising, scan, set device name and others. API Reference ------------- diff --git a/docs/api/bluetooth/esp_gattc.rst b/docs/api/bluetooth/esp_gattc.rst index eada883fd7..adfc225dfa 100644 --- a/docs/api/bluetooth/esp_gattc.rst +++ b/docs/api/bluetooth/esp_gattc.rst @@ -6,18 +6,16 @@ Overview `Instructions`_ +.. _Instructions: ../template.html + Application Example ------------------- -Check `/examples `_ folder of `espressif/esp-idf `_ repository, that contains the following example: - -`15_gattc_demo `_ +Check `/examples/bluetooth `_ folder of `espressif/esp-idf `_ repository, that contains the following example: -This is a gatt client demo. This demo can scan devices, connect to the gatt server and discover the service. +`gatt_client `_ -`Instructions`_ - -.. _Instructions: ../template.html + This is a gatt client demo. This demo can scan devices, connect to the gatt server and discover the service. API Reference diff --git a/docs/api/bluetooth/esp_gatts.rst b/docs/api/bluetooth/esp_gatts.rst index 877840402c..4753490d4d 100644 --- a/docs/api/bluetooth/esp_gatts.rst +++ b/docs/api/bluetooth/esp_gatts.rst @@ -6,19 +6,16 @@ Overview `Instructions`_ +.. _Instructions: ../template.html + Application Example ------------------- -Check `/examples `_ folder of `espressif/esp-idf `_ repository, that contains the following example: - -`14_gatts_demo `_ - -This is a gatt server demo. Use gatt api to create a gatt server with send advertising. This gatt server can be connected and the service can be discovery. +Check `/examples/bluetooth `_ folder of `espressif/esp-idf `_ repository, that contains the following example: -`Instructions`_ - -.. _Instructions: ../template.html +`gatt_server `_ + This is a gatt server demo. Use gatt api to create a gatt server with send advertising. This gatt server can be connected and the service can be discovery. API Reference ------------- diff --git a/docs/api/storage/nvs_flash.rst b/docs/api/storage/nvs_flash.rst index 00094d8697..9e97c3a811 100644 --- a/docs/api/storage/nvs_flash.rst +++ b/docs/api/storage/nvs_flash.rst @@ -3,9 +3,9 @@ Application Example ------------------- -Two examples are provided in ESP-IDF examples directory: +Two examples are provided in ESP-IDF `examples/storage `_ directory: -`storage/nvs_rw_value `_ +`nvs_rw_value `_ Demonstrates how to read and write a single integer value using NVS. @@ -13,7 +13,7 @@ Two examples are provided in ESP-IDF examples directory: Example also shows how to check if read / write operation was successful, or certain value is not initialized in NVS. Diagnostic is provided in plain text to help track program flow and capture any issues on the way. -`storage/nvs_rw_blob `_ +`nvs_rw_blob `_ Demonstrates how to read and write a single integer value and a blob (binary large object) using NVS to preserve them between ESP32 module restarts. -- 2.40.0