Documentation Update

Updated documentation to conform with pylint and sphinx.

doc/source/writing_extensions.rst

@@ -161,8 +161,8 @@ In order for the binary to be obtained in this way, it must be stored in one of
 the locations scanned by the resource resolver in a directry structure
 ``<root>/bin/<abi>/<binary>`` (where ``root`` is the base resource location to
 be searched, e.g. ``~/.workload_automation/depencencies/<extension name>``, and
- ``<abi>`` is the ABI for which the exectuable has been compiled, as returned by
+``<abi>`` is the ABI for which the exectuable has been compiled, as returned by
-  ``self.device.abi``).
+``self.device.abi``).
 
 Once the path to the host-side binary has been obtained, it may be deployed using
 one of two methods of a ``Device`` instace -- ``install`` or ``install_if_needed``.
@@ -182,8 +182,8 @@ WA and will not try to re-install.
 
 Both of the above methods will return the path to the installed binary on the
 device. The executable should be invoked *only* via that path; do **not** assume
- that it will be in ``PATH`` on the target (or that the executable with the same
+that it will be in ``PATH`` on the target (or that the executable with the same
-  name in ``PATH`` is the version deployed by WA.
+name in ``PATH`` is the version deployed by WA.
 
 .. code:: python
 

wlauto/instrumentation/freqsweep/__init__.py

@@ -55,6 +55,7 @@ class FreqSweep(Instrument):
                    - label: Workload specs will be named
                      `{spec id}_{label}_{frequency}`. If a label is not
                      provided it will be named `sweep{sweep No.}`
+
                   Example sweep specification: ::
 
                       freq_sweep:

wlauto/workloads/adobereader/__init__.py

@@ -33,6 +33,7 @@ class AdobeReader(AndroidUxPerfWorkload):
     The Adobe Reader workflow carries out the following typical productivity tasks.
 
     Test description:
+
     1. Open a local file on the device
     2. Gestures test:
         2.1. Swipe down across the central 50% of the screen in 200 x 5ms steps

wlauto/workloads/geekbench/__init__.py

@@ -94,7 +94,7 @@ class Geekbench(AndroidUiAutoBenchmark):
                   description=('If ``True`` the results file will not be pulled from the devices '
                                '/data/data/com.primatelabs.geekbench folder.  This allows the '
                                'workload to be run on unrooted devices and the results extracted '
-                               'manually later. ' )),
+                               'manually later.')),
     ]
 
     @property

wlauto/workloads/googlephotos/__init__.py

@@ -37,6 +37,7 @@ class Googlephotos(AndroidUxPerfWorkload):
     various tasks, such as browsing images, performing zooms, and post-processing the image.
 
     Test description:
+
     1. Four images are copied to the device
     2. The application is started in offline access mode
     3. Gestures are performed to pinch zoom in and out of the selected image

wlauto/workloads/googleplaybooks/__init__.py

@@ -33,15 +33,15 @@ class Googleplaybooks(AndroidUxPerfWorkload):
     and querying information about the book.
 
     Test description:
-     1. Open Google Play Books application
+    1. Open Google Play Books application
-     2. Dismisses sync operation (if applicable)
+    2. Dismisses sync operation (if applicable)
-     3. Searches for a book title
+    3. Searches for a book title
-     4. Adds books to library if not already present
+    4. Adds books to library if not already present
-     5. Opens 'My Library' contents
+    5. Opens 'My Library' contents
-     6. Opens selected  book
+    6. Opens selected book
-     7. Gestures are performed to swipe between pages and pinch zoom in and out of a page
+    7. Gestures are performed to swipe between pages and pinch zoom in and out of a page
-     8. Selects a specified chapter based on page number from the navigation view
+    8. Selects a specified chapter based on page number from the navigation view
-     9. Selects a word in the centre of screen and adds a test note to the page
+    9. Selects a word in the centre of screen and adds a test note to the page
     10. Removes the test note from the page (clean up)
     11. Searches for the number of occurrences of a common word throughout the book
     12. Switches page styles from 'Day' to 'Night' to 'Sepia' and back to 'Day'

wlauto/workloads/googleslides/__init__.py

@@ -48,6 +48,7 @@ class GoogleSlides(AndroidUxPerfWorkload):
     requires an image file specified by the param ``test_image`` to be copied onto the device.
 
     Test description:
+
     1. Start the app and skip the welcome screen. Dismiss the work offline banner if present.
     2. Go to the app settings page and enables PowerPoint compatibility mode. This allows
        PowerPoint files to be created inside Google Slides.
@@ -62,6 +63,7 @@ class GoogleSlides(AndroidUxPerfWorkload):
     file to be copied is given by ``test_file``.
 
     Test description:
+
     1. From the documents list (following the create test), open the specified PowerPoint
        by navigating into device storage and wait for it to be loaded.
     2. A navigation test is performed while the file is in editing mode (i.e. not slideshow).

wlauto/workloads/hwuitest/__init__.py

@@ -40,6 +40,7 @@ class HWUITest(Workload):
                   allowed_values=["shadowgrid", "rectgrid", "oval"],
                   description="""
                   The test to run:
+
                      - ``'shadowgrid'``: creates a grid of rounded rects that
                        cast shadows, high CPU & GPU load
                      - ``'rectgrid'``: creates a grid of 1x1 rects

wlauto/workloads/rt_app/__init__.py

@@ -49,13 +49,13 @@ class RtApp(Workload):
     The load is described using JSON-like config files. Below are a couple of simple
     examples.
 
+
+    Simple use case which creates a thread that run 1ms then sleep 9ms
+    until the use case is stopped with Ctrl+C:
+
     .. code-block:: json
 
         {
-            /*
-            * Simple use case which creates a thread that run 1ms then sleep 9ms
-            * until the use case is stopped with Ctrl+C
-            */
             "tasks" : {
                 "thread0" : {
                     "loop" : -1,
@@ -76,13 +76,13 @@ class RtApp(Workload):
             }
         }
 
+
+    Simple use case with 2 threads that runs for 10 ms and wake up each
+    other until the use case is stopped with Ctrl+C
+
     .. code-block:: json
 
         {
-            /*
-            * Simple use case with 2 threads that runs for 10 ms and wake up each
-            * other until the use case is stopped with Ctrl+C
-            */
             "tasks" : {
                 "thread0" : {
                     "loop" : -1,

wlauto/workloads/youtube/__init__.py

@@ -35,6 +35,7 @@ class Youtube(AndroidUxPerfWorkload):
     Test description:
     The ``video_source`` parameter determines where the video to be played will be found
     in the app. Possible values are ``search``, ``home``, ``my_videos``, and ``trending``.
+
     -A. search - Goes to the search view, does a search for the given term, and plays the
         first video in the results. The parameter ``search_term`` must also be provided
         in the agenda for this to work. This is the default mode.
@@ -46,6 +47,7 @@ class Youtube(AndroidUxPerfWorkload):
         video in the trending videos list.
 
     For the selected video source, the following test steps are performed:
+
     1.  Navigate to the general app settings page to disable autoplay. This improves test
         stability and predictability by preventing screen transition to load a new video
         while in the middle of the test.