From: krzychb Date: Wed, 18 Jan 2017 20:04:11 +0000 (+0100) Subject: Added links from api category TOC to example category folders X-Git-Tag: v2.0-rc1~10^2 X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=16b23a407cde7492c215c4019ddaef9200412a72;p=esp-idf Added links from api category TOC to example category folders Typo fix in bluetooth README.md --- diff --git a/docs/api/bluetooth/index.rst b/docs/api/bluetooth/index.rst index fffe674425..5a096c75ef 100644 --- a/docs/api/bluetooth/index.rst +++ b/docs/api/bluetooth/index.rst @@ -8,3 +8,5 @@ Bluetooth API Bluetooth Common Bluetooth LE + +Example code for this API section is provided in `examples/bluetooth `_ directory of ESP-IDF repository. diff --git a/docs/api/ethernet/index.rst b/docs/api/ethernet/index.rst index aeb0137c5e..31181d23ea 100644 --- a/docs/api/ethernet/index.rst +++ b/docs/api/ethernet/index.rst @@ -6,3 +6,5 @@ Ethernet API Ethernet + +Example code for this API section is provided in `examples/ethernet `_ directory of ESP-IDF repository. diff --git a/docs/api/peripherals/index.rst b/docs/api/peripherals/index.rst index 9ea0c41ab6..147a722fc6 100644 --- a/docs/api/peripherals/index.rst +++ b/docs/api/peripherals/index.rst @@ -14,3 +14,5 @@ Peripherals API LED Control Remote Control + +Example code for this API section is provided in `examples/peripherals `_ directory of ESP-IDF repository. diff --git a/docs/api/protocols/index.rst b/docs/api/protocols/index.rst index 632bd141dc..9a3a9a0c2f 100644 --- a/docs/api/protocols/index.rst +++ b/docs/api/protocols/index.rst @@ -6,3 +6,5 @@ Protocols API mDNS + +Example code for this API section is provided in `examples/protocols `_ directory of ESP-IDF repository. diff --git a/docs/api/storage/index.rst b/docs/api/storage/index.rst index 30fb2088c7..bf21cc9eea 100644 --- a/docs/api/storage/index.rst +++ b/docs/api/storage/index.rst @@ -10,3 +10,5 @@ Storage API Virtual Filesystem FAT Filesystem + +Example code for this API section is provided in `examples/storage `_ directory of ESP-IDF repository. diff --git a/docs/api/system/index.rst b/docs/api/system/index.rst index 6bbd7c10c5..f5746f80fd 100644 --- a/docs/api/system/index.rst +++ b/docs/api/system/index.rst @@ -11,3 +11,5 @@ System API Deep Sleep Logging + +Example code for this API section is provided in `examples/system `_ directory of ESP-IDF repository. diff --git a/docs/api/wifi/index.rst b/docs/api/wifi/index.rst index 2abe2b2fff..aecf87fa3b 100644 --- a/docs/api/wifi/index.rst +++ b/docs/api/wifi/index.rst @@ -6,3 +6,6 @@ Wi-Fi API Wi-Fi Smart Config + + +Example code for this API section is provided in `examples/wifi `_ directory of ESP-IDF repository. diff --git a/examples/bluetooth/README.md b/examples/bluetooth/README.md index 07bbe8ac14..3d60a59162 100644 --- a/examples/bluetooth/README.md +++ b/examples/bluetooth/README.md @@ -1,5 +1,5 @@ # Bluetooth Examples -Note: To use examples in this directory, you need to have Bluetooth enabled in configuration. Run `make menuconfig`, go to `Component config` and verify if you see `[*] Bluetooth`. If not - enable if and save. +Note: To use examples in this directory, you need to have Bluetooth enabled in configuration. Run `make menuconfig`, go to `Component config` and verify if you see `[*] Bluetooth`. If not - enable it and save. See the [README.md](../README.md) file in the upper level [examples](../) directory for more information about examples.