doc: use REPL syntax where appropriate

Most examples are meant to demonstrate some aspect on how to use
labgrid. These are best displayed as if typed into a REPL shell.

This will also ease automated testing of examples in a future commit.

Signed-off-by: Bastian Krause <bst@pengutronix.de>

Author: Bastian-Krause

doc/configuration.rst

@@ -2628,12 +2628,11 @@ to transition to the shell state:
 
 ::
 
-   from labgrid import Environment
-
-   e = Environment("local.yaml")
-   t = e.get_target("main")
-   s = t.get_driver("BareboxStrategy")
-   s.transition("shell")
+   >>> from labgrid import Environment
+   >>> e = Environment("local.yaml")
+   >>> t = e.get_target("main")
+   >>> s = t.get_driver("BareboxStrategy")
+   >>> s.transition("shell")
 
 
 this command would transition from the bootloader into a Linux shell and
@@ -2652,12 +2651,11 @@ to transition to the shell state:
 
 ::
 
-   from labgrid import Environment
-
-   e = Environment("local.yaml")
-   t = e.get_target("main")
-   s = t.get_driver("ShellStrategy")
-   s.transition("shell")
+   >>> from labgrid import Environment
+   >>> e = Environment("local.yaml")
+   >>> t = e.get_target("main")
+   >>> s = t.get_driver("ShellStrategy")
+   >>> s.transition("shell")
 
 
 this command would transition directly into a Linux shell and
@@ -2677,12 +2675,11 @@ to transition to the shell state:
 
 ::
 
-   from labgrid import Environment
-
-   e = Environment("local.yaml")
-   t = e.get_target("main")
-   s = t.get_driver("UBootStrategy")
-   s.transition("shell")
+   >>> from labgrid import Environment
+   >>> e = Environment("local.yaml")
+   >>> t = e.get_target("main")
+   >>> s = t.get_driver("UBootStrategy")
+   >>> s.transition("shell")
 
 
 this command would transition from the bootloader into a Linux shell and
@@ -2701,12 +2698,11 @@ To transition to the shell state:
 
 ::
 
-   from labgrid import Environment
-
-   e = Environment("local.yaml")
-   t = e.get_target("main")
-   s = t.get_driver("DockerShellStrategy")
-   s.transition("shell")
+   >>> from labgrid import Environment
+   >>> e = Environment("local.yaml")
+   >>> t = e.get_target("main")
+   >>> s = t.get_driver("DockerShellStrategy")
+   >>> s.transition("shell")
 
 
 These commands would activate the docker driver which creates and starts
@@ -2727,17 +2723,15 @@ The StepReporter outputs individual labgrid steps to `STDOUT`.
 
 ::
 
-    from labgrid import StepReporter
-
-    StepReporter.start()
+    >>> from labgrid import StepReporter
+    >>> StepReporter.start()
 
 The Reporter can be stopped with a call to the stop function:
 
 ::
 
-    from labgrid import StepReporter
-
-    StepReporter.stop()
+    >>> from labgrid import StepReporter
+    >>> StepReporter.stop()
 
 Stopping the StepReporter if it has not been started will raise an
 AssertionError, as will starting an already started StepReporter.
@@ -2754,17 +2748,15 @@ files. It takes the path as a parameter.
 
 ::
 
-    from labgrid import ConsoleLoggingReporter
-
-    ConsoleLoggingReporter.start(".")
+    >>> from labgrid import ConsoleLoggingReporter
+    >>> ConsoleLoggingReporter.start(".")
 
 The Reporter can be stopped with a call to the stop function:
 
 ::
 
-    from labgrid import ConsoleLoggingReporter
-
-    ConsoleLoggingReporter.stop()
+    >>> from labgrid import ConsoleLoggingReporter
+    >>> ConsoleLoggingReporter.stop()
 
 
 Stopping the ConsoleLoggingReporter if it has not been started will raise an

doc/development.rst

@@ -515,25 +515,22 @@ To use the SSHManager in your code, import it from :any:`labgrid.util.ssh`:
 
 .. code-block:: python
 
-   from labgrid.util import sshmanager
+   >>> from labgrid.util import sshmanager
 
 you can now request or remove port forwardings:
 
 .. code-block:: python
 
-   from labgrid.util import sshmanager
-
-   localport = sshmanager.request_forward('localhost', 'somehost', 3000)
-
-   sshmanager.remove_forward('localhost', 'somehost', 3000)
+   >>> from labgrid.util import sshmanager
+   >>> localport = sshmanager.request_forward('localhost', 'somehost', 3000)
+   >>> sshmanager.remove_forward('localhost', 'somehost', 3000)
 
 or get and put files:
 
 .. code-block:: python
 
-   from labgrid.util import sshmanager
-
-   sshmanager.put_file('somehost', '/path/to/local/file', '/path/to/remote/file')
+   >>> from labgrid.util import sshmanager
+   >>> sshmanager.put_file('somehost', '/path/to/local/file', '/path/to/remote/file')
 
 .. note::
   The SSHManager will reuse existing Control Sockets and set up a keepalive loop
@@ -556,11 +553,10 @@ To use it in conjunction with a `Resource` and a file:
 
 .. code-block:: python
 
-   from labgrid.util.managedfile import ManagedFile
-
-   mf = ManagedFile(<your-file>, <your-resource>)
-   mf.sync_to_resource()
-   path = mf.get_remote_path()
+   >>> from labgrid.util.managedfile import ManagedFile
+   >>> mf = ManagedFile(<your-file>, <your-resource>)
+   >>> mf.sync_to_resource()
+   >>> path = mf.get_remote_path()
 
 Unless constructed with `ManagedFile(..., detect_nfs=False)`, ManagedFile
 employs the following heuristic to check if a file is stored on a NFS share
@@ -585,9 +581,8 @@ Usage:
 
 .. code-block:: python
 
-   from labgrid.util.proxy import proxymanager
-
-   proxymanager.get_host_and_port(<resource>)
+   >>> from labgrid.util.proxy import proxymanager
+   >>> proxymanager.get_host_and_port(<resource>)
 
 
 .. _contributing: