Bug 1536103 - Fix various Sphinx Warning in 'mach doc' (3). r=ahal

Differential Revision: https://phabricator.services.mozilla.com/D35314

--HG--
extra : moz-landing-system : lando

mobile/android/docs/mma.rst

@@ -112,78 +112,150 @@ There are three elements that are used for each event. They are: event name, val
 Default value for event value is 0.0. Default value for event info is empty string.
 
 List of current Events related data that is sent:
+
 * When a page could be reader mode and is visible to the user
-{
-  "event" : "E_Reader_Available"
-}
+
+.. code-block:: json
+
+    {
+      "event": "E_Reader_Available"
+    }
+
 * Download videos or any other media
-{
-  "event" : "E_Download_Media_Saved_Image"
-}
+
+.. code-block:: json
+
+    {
+      "event" : "E_Download_Media_Saved_Image"
+    }
+
 * Save password and login from door hanger
-{
-  "event" : "E_Saved_Login_And_Password"
-}
+
+.. code-block:: json
+
+    {
+      "event" : "E_Saved_Login_And_Password"
+    }
+
 * Save a bookmark from Fennec menu
-{
-  "event" : "E_Saved_Bookmark"
-}
+
+.. code-block:: json
+
+    {
+      "event" : "E_Saved_Bookmark"
+    }
+
 * Load the bookmark from home panel
-{
-  "event" : "E_Opened_Bookmark"
-}
+
+.. code-block:: json
+
+    {
+      "event" : "E_Opened_Bookmark"
+    }
+
 * Interact with search url area
-{
-  "event" : "E_Interact_With_Search_URL_Area"
-}
+
+.. code-block:: json
+
+    {
+      "event" : "E_Interact_With_Search_URL_Area"
+    }
+
 * Interact with search widget
-{
-  "event" : "E_Interact_With_Search_Widget"
-}
+
+.. code-block:: json
+
+    {
+      "event" : "E_Interact_With_Search_Widget"
+    }
+
 * When a screenshot is taken
-{
-  "event" : "E_Screenshot"
-}
+
+.. code-block:: json
+
+    {
+      "event" : "E_Screenshot"
+    }
+
 * Open a new tab
-{
-  "event" : "E_Opened_New_Tab"
-}
+
+.. code-block:: json
+
+    {
+      "event" : "E_Opened_New_Tab"
+    }
+
 * App start but Fennec is not set as default browser
-{
-  "event" : "E_Launch_But_Not_Default_Browser"
-}
+
+.. code-block:: json
+
+    {
+      "event" : "E_Launch_But_Not_Default_Browser"
+    }
+
 * General app start event
-{
-  "event" : "E_Launch_Browser"
-}
+
+.. code-block:: json
+
+    {
+      "event" : "E_Launch_Browser"
+    }
+
 * The user just dismissed on-boarding
-{
-  "event" : "E_Dismiss_Onboarding"
-}
+
+.. code-block:: json
+
+    {
+      "event" : "E_Dismiss_Onboarding"
+    }
+
 * Sign in Firefox Account
-{
-  "event" : "E_User_Signed_In_To_FxA"
-}
+
+.. code-block:: json
+
+    {
+      "event" : "E_User_Signed_In_To_FxA"
+    }
+
 * Firefox Sync finished event
-{
-  "event" : "E_User_Finished_Sync"
-}
+
+.. code-block:: json
+
+    {
+      "event" : "E_User_Finished_Sync"
+    }
+
 * The user just resumed the app from background
-{
-  "event" : "E_Resumed_From_Background"
-}
+
+.. code-block:: json
+
+    {
+      "event" : "E_Resumed_From_Background"
+    }
+
 * User set Fennec as default browser and resumed the app
-{
-  "event" : "E_Changed_Default_To_Fennec"
-}
+
+.. code-block:: json
+
+    {
+      "event" : "E_Changed_Default_To_Fennec"
+    }
+
 * User installed the Focus app
-{
-  "event" : "E_Just_Installed_Focus"
-}
+
+.. code-block:: json
+
+    {
+      "event" : "E_Just_Installed_Focus"
+    }
+
 * User installed the Klar app
-{
-  "event" : "E_Just_Installed_Klar"
-}
+
+.. code-block:: json
+
+    {
+      "event" : "E_Just_Installed_Klar"
+    }
 
 Deep Links:
 Deep links are actions that can point Fennec to open certain pages or load features such as `show bookmark list` or

mobile/android/docs/push.rst

@@ -124,7 +124,7 @@ same *uaid* until the client's configuration changes or the service expires the
 registration due to inactivity or an unexpected server event.  Each
 `PushSubscription` is associated to a given *uaid* and corresponds to a unique
 (per-*uaid*) *chid* (Channel ID) on the autopush server.  An individual *chid*
-is potentially long-lived, but clients must expect the service to expire *chid*s
+is potentially long-lived, but clients must expect the service to expire *chid*'s`
 as part of regular maintenance.  The `PushManager` uses an `AutopushClient`
 instance to interact with the autopush server.
 
@@ -142,4 +142,4 @@ Socket and HTTP2 backed services, which simply delegates to the Fennec
 There are some complications: first, Gecko must maintain the autopush
 configuration; and second, it is possible for the push system to change while
 Gecko is not running.  Therefore, the communication is bi-directional
-throughout, so that Gecko can react to Fennec events after-the-fact.
+throughout, so that Gecko can react to Fennec events after-the-fact.

python/mozbuild/mozbuild/backend/recursivemake.py

@@ -300,6 +300,7 @@ class RecursiveMakeTraversal(object):
         SubDirectories members.
 
         The default filter corresponds to a default recursive traversal.
+
         """
         filter = filter or self.default_filter
 

python/mozbuild/mozbuild/configure/__init__.py

@@ -825,6 +825,7 @@ class ConfigureSandbox(dict):
         This decorator imports the given _import from the given _from module
         optionally under a different _as name.
         The options correspond to the various forms for the import builtin.
+
             @imports('sys')
             @imports(_from='mozpack', _import='path', _as='mozpath')
         '''
@@ -981,29 +982,37 @@ class ConfigureSandbox(dict):
         The `value` argument indicates the value to pass to the option.
         It can be:
         - True. In this case `imply_option` injects the positive option
+
           (--enable-foo/--with-foo).
               imply_option('--enable-foo', True)
               imply_option('--disable-foo', True)
+
           are both equivalent to `--enable-foo` on the command line.
 
         - False. In this case `imply_option` injects the negative option
+
           (--disable-foo/--without-foo).
               imply_option('--enable-foo', False)
               imply_option('--disable-foo', False)
+
           are both equivalent to `--disable-foo` on the command line.
 
         - None. In this case `imply_option` does nothing.
               imply_option('--enable-foo', None)
               imply_option('--disable-foo', None)
-          are both equivalent to not passing any flag on the command line.
+
+        are both equivalent to not passing any flag on the command line.
 
         - a string or a tuple. In this case `imply_option` injects the positive
           option with the given value(s).
+
               imply_option('--enable-foo', 'a')
               imply_option('--disable-foo', 'a')
+
           are both equivalent to `--enable-foo=a` on the command line.
               imply_option('--enable-foo', ('a', 'b'))
               imply_option('--disable-foo', ('a', 'b'))
+
           are both equivalent to `--enable-foo=a,b` on the command line.
 
         Because imply_option('--disable-foo', ...) can be misleading, it is

python/mozbuild/mozbuild/dotproperties.py

@@ -66,7 +66,7 @@ class DotProperties:
     def get_dict(self, prefix, required_keys=[]):
         '''Turns {'foo.title':'title', ...} into {'title':'title', ...}.
 
-        If |required_keys| is present, it must be an iterable of required key
+        If ``|required_keys|`` is present, it must be an iterable of required key
         names.  If a required key is not present, ValueError is thrown.
 
         Returns {} to indicate an empty or missing dict.'''

python/mozbuild/mozbuild/mach_commands.py

@@ -1315,10 +1315,10 @@ class PackageFrontend(MachCommandBase):
     def artifact(self):
         '''Download, cache, and install pre-built binary artifacts to build Firefox.
 
-        Use |mach build| as normal to freshen your installed binary libraries:
+        Use ``|mach build|`` as normal to freshen your installed binary libraries:
         artifact builds automatically download, cache, and install binary
         artifacts from Mozilla automation, replacing whatever may be in your
-        object directory.  Use |mach artifact last| to see what binary artifacts
+        object directory.  Use ``|mach artifact last|`` to see what binary artifacts
         were last used.
 
         Never build libxul again!

python/mozbuild/mozbuild/mozinfo.py

@@ -138,7 +138,7 @@ def build_dict(config, env=os.environ):
 
 def write_mozinfo(file, config, env=os.environ):
     """Write JSON data about the configuration specified in config and an
-    environment variable dict to |file|, which may be a filename or file-like
+    environment variable dict to ``|file|``, which may be a filename or file-like
     object.
     See build_dict for information about what  environment variables are used,
     and what keys are produced.

taskcluster/taskgraph/util/parameterization.py

@@ -40,7 +40,9 @@ def resolve_task_references(label, task_def, dependencies):
       {'task-reference': '..<..>..'}
     and
       {'artifact-reference`: '..<dependency/artifact/path>..'}
-    in the given task definition, using the given dependencies"""
+    in the given task definition, using the given dependencies
+
+    """
 
     def task_reference(val):
         def repl(match):