Merge branch 'new_engine' into overview_changes

Author: Amanda Butler

check_tools/find_bad_doxy_references.py

@@ -0,0 +1,68 @@
+#!/usr/bin/env python
+
+import os
+import sys
+import re
+import requests
+from subprocess import check_output
+from builtins import input, open
+
+PATTERN = (
+    "\[!\[View code\]\(https://www\.mbed\.com/embed/\?type=library\)\]"
+    "\((.*)\)"
+)
+
+def main(path=None):
+    bad = False
+    interactive = False
+
+    if not path:
+        interactive = True
+
+        # Go to root to make paths easier
+        root = check_output(['git', 'rev-parse', '--show-toplevel']).strip()
+        os.chdir(root)
+
+        # Ask for path in case user is unfamiliar with command line
+        path = input('What directory should I check? ')
+
+    for dir, dirs, files in os.walk(path):
+        for file in files:
+            if not file.endswith('.md'):
+                continue
+
+            path = os.path.join(dir, file)
+            with open(path, encoding='utf-8') as file:
+                for i, line in enumerate(file):
+                    for match in re.findall(PATTERN, line):
+                        if match.startswith('https:'):
+                            sys.stderr.write("\n%s:%s: Bad URL (https):\n" % (path, i))
+                            sys.stderr.write(match + '\n')
+                            bad = True
+
+                        try:
+                            code = requests.get(match).status_code
+                        except requests.exceptions.RequestException:
+                            code = -1
+
+                        if code != 200:
+                            sys.stderr.write("\n%s:%s: Bad URL (%d):\n" % (path, i, code))
+                            sys.stderr.write(match + '\n')
+                            bad = True
+
+                        sys.stdout.write('.')
+                        sys.stdout.flush()
+
+        for dir in dirs:
+            if dir.startswith('.'):
+                dirs.remove(dir)
+
+    sys.stdout.write('\nDone!\n')
+    if interactive:
+        input('Hit any key to continue ')
+
+    return 0 if not bad else 1
+
+
+if __name__ == "__main__":
+    sys.exit(main(*sys.argv[1:]))

docs.json

@@ -364,6 +364,14 @@
                                 "type": "markdown",
                                 "url": "https://github.com/ARMmbed/Handbook/blob/new_engine/docs/reference/api/connectivity/bluetooth/BLE.md"
                             },
+                            {
+                                "type": "markdown",
+                                "url": "https://github.com/ARMmbed/Handbook/blob/new_engine/docs/reference/api/connectivity/bluetooth/Gap.md"
+                            },
+                            {
+                                "type": "markdown",
+                                "url": "https://github.com/ARMmbed/Handbook/blob/new_engine/docs/reference/api/connectivity/bluetooth/SecurityManager.md"
+                            },
                             {
                                 "type": "markdown",
                                 "url": "https://github.com/ARMmbed/Handbook/blob/new_engine/docs/reference/api/connectivity/bluetooth/BatteryService.md"
@@ -378,6 +386,26 @@
                             }
                         ]
                     },
+                    {
+                        "title": "LoRaWAN",
+                        "intro": {
+                            "type": "markdown",
+                            "url": "https://github.com/ARMmbed/Handbook/blob/new_engine/docs/reference/api/connectivity/lorawan/lorawanevents.md"
+                        },
+                        "sources": [{
+                                "type": "markdown",
+                                "url": "https://github.com/ARMmbed/Handbook/blob/new_engine/docs/reference/api/connectivity/lorawan/lorawan.md"
+                            },
+                            {
+                                "type": "markdown",
+                                "url": "https://github.com/ARMmbed/Handbook/blob/new_engine/docs/reference/api/connectivity/lorawan/loraradio.md"
+                            },
+                            {
+                                "type": "markdown",
+                                "url": "https://github.com/ARMmbed/Handbook/blob/new_engine/docs/reference/api/connectivity/lorawan/lorawanconfig.md"
+                            }
+                        ]
+                    },
                     {
                         "title": "Security",
                         "intro": {
@@ -484,7 +512,11 @@
                     },
                     {
                         "type": "markdown",
-                        "url": "https://github.com/ARMmbed/Handbook/blob/new_engine/docs/reference/contributing/target/ticker.md"
+                        "url": "https://github.com/ARMmbed/Handbook/blob/new_engine/docs/reference/contributing/target/us_ticker.md"
+                    },
+                    {
+                        "type": "markdown",
+                        "url": "https://github.com/ARMmbed/Handbook/blob/new_engine/docs/reference/contributing/target/lp_ticker.md"
                     },
                     {
                         "type": "markdown",
@@ -681,6 +713,10 @@
                         "type": "markdown",
                         "url": "https://github.com/ARMmbed/Handbook/blob/new_engine/docs/tools/debug/debugging_mbed_os_apps.md"
                     },
+                    {
+                        "type": "markdown",
+                        "url": "https://github.com/ARMmbed/Handbook/blob/new_engine/docs/tools/debug/crash_dump_analyzer.md"
+                    },
                     {
                         "type": "markdown",
                         "url": "https://github.com/ARMmbed/Handbook/blob/new_engine/docs/tools/debug/local_debugging_toolchain.md"
@@ -732,18 +768,26 @@
                 }]
             },
             {
-                "title": "Arm Mbed OS Quickstart",
+                "title": "Mbed OS quick start",
                 "sources": [{
                         "type": "markdown",
-                        "url": "https://github.com/ARMmbed/Handbook/blob/new_engine/docs/tutorials/quickstart/quickstart.md"
+                        "url": "https://github.com/ARMmbed/Handbook/blob/new_engine/docs/tutorials/quickstart/quick-start.md"
                     },
                     {
                         "type": "markdown",
-                        "url": "https://github.com/ARMmbed/Handbook/blob/new_engine/docs/tutorials/quickstart/quickstart-compiler.md"
+                        "url": "https://github.com/ARMmbed/Handbook/blob/new_engine/docs/tutorials/quickstart/quick-start-compiler.md"
                     },
                     {
                         "type": "markdown",
-                        "url": "https://github.com/ARMmbed/Handbook/blob/new_engine/docs/tutorials/quickstart/quickstart-cli.md"
+                        "url": "https://github.com/ARMmbed/Handbook/blob/new_engine/docs/tutorials/quickstart/quick-start-cli.md"
+                    }
+                ]
+            },
+            {
+                "title": "Major releases",
+                "sources": [{
+                        "type": "markdown",
+                        "url": "https://github.com/ARMmbed/Handbook/blob/new_engine/docs/tutorials/mbed-os-2-vs-5.md"
                     }
                 ]
             },
@@ -768,7 +812,7 @@
                 ]
             },
             {
-                "title": "Serial Communication",
+                "title": "Serial communication",
                 "sources": [{
                         "type": "markdown",
                         "url": "https://github.com/ARMmbed/Handbook/blob/new_engine/docs/tutorials/serial/serial-overview.md"
@@ -845,6 +889,10 @@
                         "type": "markdown",
                         "url": "https://github.com/ARMmbed/Handbook/blob/new_engine/docs/tutorials/debug/debug_tutorials.md"
                     },
+                    {
+                        "type": "markdown",
+                        "url": "https://github.com/ARMmbed/Handbook/blob/new_engine/docs/tutorials/debug/debug_fault_exception.md"
+                    },
                     {
                         "type": "markdown",
                         "url": "https://github.com/ARMmbed/Handbook/blob/new_engine/docs/tutorials/run_and_compile_time_errors.md"
@@ -898,5 +946,71 @@
         "tags": [
             "tutorials"
         ]
+    },
+    {
+        "title": "Mbed OS API doxygen",
+        "description": "The full Mbed OS API documentation in doxygen format",
+        "slug": "mbed-os-api-doxy",
+        "hidden": true,
+        "type": "doxygen",
+        "source": "https://github.com/ARMmbed/mbed-os",
+        "branch": "mbed-os-5.8"
+    },
+    {
+        "title": "feature-hal-spec-rtc doxygen",
+        "description": "The full mbed OS API documentation in doxygen format",
+        "slug": "feature-hal-spec-rtc-doxy",
+        "hidden": true,
+        "type": "doxygen",
+        "source": "https://github.com/ARMmbed/mbed-os",
+        "branch": "feature-hal-spec-rtc"
+    },
+    {
+        "title": "feature-hal-spec-sleep doxygen",
+        "description": "The full mbed OS API documentation in doxygen format",
+        "slug": "feature-hal-spec-sleep-doxy",
+        "hidden": true,
+        "type": "doxygen",
+        "source": "https://github.com/ARMmbed/mbed-os",
+        "branch": "feature-hal-spec-sleep"
+    },
+    {
+        "title": "feature-hal-spec-ticker doxygen",
+        "description": "The full mbed OS API documentation in doxygen format",
+        "slug": "feature-hal-spec-ticker-doxy",
+        "hidden": true,
+        "type": "doxygen",
+        "source": "https://github.com/ARMmbed/mbed-os",
+        "branch": "feature-hal-spec-ticker"
+    },
+    {
+        "title": "feature-hal-spec-usb-device doxygen",
+        "description": "The full mbed OS API documentation in doxygen format",
+        "slug": "feature-hal-spec-usb-device-doxy",
+        "hidden": true,
+        "type": "doxygen",
+        "source": "https://github.com/ARMmbed/mbed-os",
+        "branch": "feature-hal-spec-usb-device"
+
+    },
+    {
+        "title": "feature-hal-spec-qspi doxygen",
+        "description": "The full mbed OS API documentation in doxygen format",
+        "slug": "feature-hal-spec-qspi-doxy",
+        "hidden": true,
+        "type": "doxygen",
+        "source": "https://github.com/ARMmbed/mbed-os",
+        "branch": "feature-qspi"
+
+    },
+    {
+        "title": "feature-hal-spec-watchdog doxygen",
+        "description": "The full mbed OS API documentation in doxygen format",
+        "slug": "feature-hal-spec-watchdog-doxy",
+        "hidden": true,
+        "type": "doxygen",
+        "source": "https://github.com/ARMmbed/mbed-os",
+        "branch": "feature-watchdog"
+
     }
 ]

docs/images/Mbed-Studio-Blinky-Main-CPP.png

@@ -6,45 +6,45 @@ Your application code is written in C and C++. It uses the *application programm
 
 #### Where to start
 
-<span class="tips">If you're working on Windows, you might need to [install a serial driver](/docs/v5.7/tutorials/windows-serial-driver.html).
+<span class="tips">If you're working on Windows, you might need to [install a serial driver](/docs/development/tutorials/windows-serial-driver.html).
 
-The easiest way to work with Mbed OS is using one of our development tools. We've set up an example, [Blinky](/docs/v5.7/tutorials/your-first-program.html), that you can try on each of the tools. Blinky teaches you to build and run an application on your board.
+The easiest way to work with Mbed OS is using one of our development tools. We've set up an example, [Blinky](/docs/development/tutorials/your-first-program.html), that you can try on each of the tools. Blinky teaches you to build and run an application on your board.
 
-Once you know how to build an existing application, it's time to learn [how to write your own applications](/docs/v5.7/reference/index.html).
+Once you know how to build an existing application, it's time to learn [how to write your own applications](/docs/development/reference/index.html).
 
 ##### Development tools
 
-- Our offline development tool is [Arm Mbed CLI](/docs/v5.7/tools/arm-mbed-cli.html), a command-line tool. This requires having a toolchain installed on your computer.
-- The [Arm Mbed Online Compiler](/docs/v5.7/tools/arm-online-compiler.html) lets you write and build applications using a web browser.
-- If you're working with third party tools, look at [exporting instructions for the most popular ones](/docs/v5.7/tools/exporting.html).
+- Our offline development tool is [Arm Mbed CLI](/docs/development/tools/arm-mbed-cli.html), a command-line tool. This requires having a toolchain installed on your computer.
+- The [Arm Mbed Online Compiler](/docs/development/tools/arm-online-compiler.html) lets you write and build applications using a web browser.
+- If you're working with third party tools, look at [exporting instructions for the most popular ones](/docs/development/tools/exporting.html).
 
 ##### Communicating with and monitoring your board
 
-You can [monitor and control an Mbed board](/docs/v5.7/tutorials/serial-comm.html) to help you debug and test your applications.
+You can [monitor and control an Mbed board](/docs/development/tutorials/serial-comm.html) to help you debug and test your applications.
 
-<span class="tips">**Tip:** Learn more about debugging in the [debugging applications section](/docs/v5.7/tutorials/debugging-applications.html).</span>
+<span class="tips">**Tip:** Learn more about debugging in the [debugging applications section](/docs/development/tutorials/debugging-applications.html).</span>
 
 #### How to continue
 
 When you've started writing applications using your selected development tool:
 
-- Learn about [collaborative work and version control](/docs/v5.7/tools/collab-online-comp.html).
-- Try one of the [tutorials](/docs/v5.7/tutorials/index.html), which cover concepts such as debugging and memory tracing.
+- Learn about [collaborative work and version control](/docs/development/tools/collab-online-comp.html).
+- Try one of the [tutorials](/docs/development/tutorials/index.html), which cover concepts such as debugging and memory tracing.
 - Ask questions and give advice on the [forum](https://os.mbed.com/forum/).
 
 #### Contributing to Mbed OS
 
-If you want to contribute to the `mbed-os` codebase, please see [the contribution section](/docs/v5.7/reference/contributing.html).
+If you want to contribute to the `mbed-os` codebase, please see [the contribution section](/docs/development/reference/contributing.html).
 
 You can find past releases and the current release on [GitHub](https://github.com/ARMmbed/mbed-os/releases/).
 
 #### Porting to Mbed OS
 
 Our full contributing guide is still being written. For now, we have:
 
-- A guide to [contributing targets](/docs/v5.7/reference/contributing-target.html).
-- Information about the [tools you need to contribute targets](/docs/v5.7/reference/contributing-tools.html).
-- APIs about [storage](/docs/v5.7/reference/contributing-storage.html) and [connectivity](/docs/v5.7/reference/contributing-connectivity.html) in relation to porting.
+- A guide to [contributing targets](/docs/development/reference/contributing-target.html).
+- Information about the [tools you need to contribute targets](/docs/development/reference/contributing-tools.html).
+- APIs about [storage](/docs/development/reference/contributing-storage.html) and [connectivity](/docs/development/reference/contributing-connectivity.html) in relation to porting.
 
 ## How Mbed works
 
@@ -73,7 +73,7 @@ The `.bin` files the Mbed microcontroller accepts are standard raw binaries. Use
 
 #### The Arm Mbed interface
 
-You can find more information about the Mbed interface and the circuits on which it runs in the [HDK reference manual](/docs/v5.7/reference/contributing-tools.html#arm-mbed-hdk) or on the [DAPLink page](/docs/v5.7/tools/daplink.html). The HDK includes reference circuits you can use to create your own boards, and DAPLink is the firmware that runs on these circuits.
+You can find more information about the Mbed interface and the circuits on which it runs in the [HDK reference manual](/docs/development/reference/contributing-tools.html#arm-mbed-hdk) or on the [DAPLink page](/docs/development/tools/daplink.html). The HDK includes reference circuits you can use to create your own boards, and DAPLink is the firmware that runs on these circuits.
 
 #### Connectivity