Merge pull request #29890 from multani/fix/docs

Various documentation fixes

doc/ref/configuration/master.rst

@@ -2794,7 +2794,7 @@ for pre-2015.8.0 minions. 2015.8.0 and later minions use
 .. conf_master:: winrepo_dir_ng
 
 ``winrepo_dir_ng``
----------------
+------------------
 
 .. versionadded:: 2015.8.0
     A new :ref:`ng <windows-package-manager>` repo was added.
@@ -2865,7 +2865,7 @@ event that an error is introduced in the latest revision of the repo.
 .. conf_master:: winrepo_remotes_ng
 
 ``winrepo_remotes_ng``
--------------------
+----------------------
 
 .. versionadded:: 2015.8.0
     A new :ref:`ng <windows-package-manager>` repo was added.

doc/ref/configuration/minion.rst

@@ -484,7 +484,7 @@ behavior is to have time-frame within all minions try to reconnect.
 .. conf_minion:: return_retry_timer
 
 ``return_retry_timer``
--------------------
+----------------------
 
 Default: ``5``
 
@@ -498,7 +498,7 @@ The default timeout for a minion return attempt.
 .. conf_minion:: return_retry_timer_max
 
 ``return_retry_timer_max``
--------------------
+--------------------------
 
 Default: ``10``
 

doc/ref/file_server/dynamic-modules.rst

@@ -1,8 +1,7 @@
 .. _module-sync:
-
-===========================
 .. _dynamic-module-distribution:
 
+===========================
 Dynamic Module Distribution
 ===========================
 
@@ -51,4 +50,4 @@ Sync Via the saltutil Module
 The saltutil module has a number of functions that can be used to sync all
 or specific dynamic modules. The saltutil module function ``saltutil.sync_all``
 will sync all module types over to a minion. For more information see:
-:mod:`salt.modules.saltutil`
+:mod:`salt.modules.saltutil`

doc/topics/cloud/aws.rst

@@ -912,7 +912,7 @@ point, and should be stored immediately.
     salt-cloud -f create_keypair ec2 keyname=mykeypair
 
 Importing a Key Pair
--------------------
+--------------------
 
 .. code-block:: bash
 

doc/topics/event/index.rst

@@ -1,8 +1,8 @@
-.. _events:
-
 .. index:: ! Event, event bus, event system
     see: Reactor; Event
 
+.. _events:
+
 =================
 Salt Event System
 =================

doc/topics/pillar/index.rst

@@ -410,4 +410,4 @@ protected data set ``pillar_safe_render_error`` to ``False``:
 
 .. code-block:: yaml
 
-    pillar_safe_render_error: True
+    pillar_safe_render_error: False

salt/modules/ifttt.py

@@ -77,11 +77,6 @@ def trigger_event(event=None, **kwargs):
     :param event:   The name of the event to trigger.
 
     :return:        A dictionary with status, text, and error if result was failure.
-
-    CLI Example:
-
-    .. code-block:: yaml
-        TBA
     '''
 
     res = {'result': False, 'message': 'Something went wrong'}

salt/netapi/rest_cherrypy/app.py

@@ -118,24 +118,24 @@ The token may be sent in one of two ways:
 
   For example, using curl:
 
-    .. code-block:: bash
+  .. code-block:: bash
 
-        curl -sSk https://localhost:8000/login \\
-            -H 'Accept: application/x-yaml' \\
-            -d username=saltdev \\
-            -d password=saltdev \\
-            -d eauth=auto
+      curl -sSk https://localhost:8000/login \\
+          -H 'Accept: application/x-yaml' \\
+          -d username=saltdev \\
+          -d password=saltdev \\
+          -d eauth=auto
 
-Copy the ``token`` value from the output and include it in subsequent requests:
+  Copy the ``token`` value from the output and include it in subsequent requests:
 
-    .. code-block:: bash
+  .. code-block:: bash
 
-        curl -sSk https://localhost:8000 \\
-            -H 'Accept: application/x-yaml' \\
-            -H 'X-Auth-Token: 697adbdc8fe971d09ae4c2a3add7248859c87079'\\
-            -d client=local \\
-            -d tgt='*' \\
-            -d fun=test.ping
+      curl -sSk https://localhost:8000 \\
+          -H 'Accept: application/x-yaml' \\
+          -H 'X-Auth-Token: 697adbdc8fe971d09ae4c2a3add7248859c87079'\\
+          -d client=local \\
+          -d tgt='*' \\
+          -d fun=test.ping
 
 * Sent via a cookie. This option is a convenience for HTTP clients that
   automatically handle cookie support (such as browsers).
@@ -1628,7 +1628,7 @@ class Run(LowDataAdapter):
 
         All SSH client requests are synchronous.
 
-        ** Example SSH client request:**
+        **Example SSH client request:**
 
         .. code-block:: bash
 
@@ -1677,6 +1677,7 @@ class Events(object):
     Salt infrastructure.
 
     .. seealso:: :ref:`events`
+
     '''
     exposed = True
 
@@ -1916,7 +1917,7 @@ class WebsocketEndpoint(object):
         :status 401: |401|
         :status 406: |406|
 
-        **Example request:**
+        **Example request:** ::
 
             curl -NsSk \\
                 -H 'X-Auth-Token: ffedf49d' \\

salt/pillar/sql_base.py

@@ -149,7 +149,7 @@ It is capable of handling single rows or multiple rows per minion.
 Configuration of the connection depends on the adapter in use.
 
 More complete example for MySQL (to also show configuration)
-=====================================
+============================================================
 
 .. code-block:: yaml
 

salt/roster/cloud.py

@@ -13,6 +13,7 @@ To connect as a user other than root, modify the cloud configuration file
 usually located at /etc/salt/cloud. For example, add the following:
 
 .. code-block:: yaml
+
     ssh_username: my_user
     sudo: True
 '''

salt/states/boto_iam.py

@@ -101,6 +101,7 @@ passed in as a dict, or as a string to pull from pillars or minion config:
         - name: mycert
 
 .. code-block:: yaml
+
     create keys for user:
       boto_iam.keys_present:
         - name: myusername

salt/states/postgres_tablespace.py

@@ -6,6 +6,7 @@ Management of PostgreSQL tablespace
 A module used to create and manage PostgreSQL tablespaces.
 
 .. code-block:: yaml
+
     ssd-tablespace:
       postgres_tablespace.present:
         - name: indexes

salt/states/reg.py

@@ -364,7 +364,7 @@ def key_absent(name, force=False, use_32bit_registry=False):
 
     Example:
 
-    .. codeblock:: yaml
+    .. code-block:: yaml
 
         'HKEY_CURRENT_USER\SOFTWARE\Salt':
           reg.key_absent:

salt/states/x509.py

@@ -125,6 +125,7 @@ handle properly formatting the text before writing the output.
 /srv/salt/cert.sls
 
 .. code-block:: yaml
+
     /usr/local/share/ca-certificates:
       file.directory: []