Documentation rendering fixes (#37543)

* doc: fix documentation rendering of salt.runners.survey

* doc: fix Sphinx documentation warnings

doc/ref/configuration/master.rst

@@ -2934,7 +2934,7 @@ master, specify the log_file of the syndic daemon.
 
     syndic_log_file: salt-syndic.log
 
-.. master_conf:: syndic_failover
+.. conf_master:: syndic_failover
 
 ``syndic_failover``
 -------------------

doc/ref/configuration/minion.rst

@@ -952,7 +952,7 @@ The port number used for HTTP proxy access.
 .. conf_minion:: proxy_username
 
 ``proxy_username``
---------------
+------------------
 
 Default: ``''``
 
@@ -965,7 +965,7 @@ The username used for HTTP proxy access.
 .. conf_minion:: proxy_password
 
 ``proxy_password``
---------------
+------------------
 
 Default: ``''``
 

doc/topics/blackout/index.rst

@@ -19,7 +19,7 @@ Salt also supports an explicit whitelist of additional functions that will be
 allowed during blackout. This is configured with the special pillar key
 ``minion_blackout_whitelist``, which is formed as a list:
 
-.. code_block:: yaml
+.. code-block:: yaml
 
     minion_blackout_whitelist:
       - test.ping

doc/topics/cloud/azure.rst

@@ -198,7 +198,7 @@ The name of the service in which to create the VM. If this is not specified,
 then a service will be created with the same name as the VM.
 
 virtual_network_name
-------------
+--------------------
 Optional. The name of the virtual network for the VM to join. If this is not
 specified, then no virtual network will be joined.
 

doc/topics/releases/releasecandidate.rst

@@ -23,11 +23,11 @@ Builds for a few platforms are available as part of the RC at:
     https://repo.saltstack.com/, but insert ``salt_rc/`` into the URL between
     the hostname and the remainder of the path.  For example:
 
-    .. code-block::
+    .. code-block:: none
 
         baseurl=https://repo.saltstack.com/salt_rc/yum/redhat/$releasever/$basearch/
 
-    .. code-block::
+    .. code-block:: none
 
         deb http://repo.saltstack.com/salt_rc/apt/ubuntu/14.04/amd64 jessie main
 

doc/topics/tutorials/http.rst

@@ -377,7 +377,7 @@ using the ``ca_bundle`` variable.
     )
 
 Updating CA Bundles
-+++++++++++++++++++
+'''''''''''''''''''
 The ``update_ca_bundle()`` function can be used to update the bundle file at a
 specified location. If the target location is not specified, then it will
 attempt to auto-detect the location of the bundle file. If the URL to download

salt/modules/chocolatey.py

@@ -683,7 +683,7 @@ def upgrade(name,
             force_x86=False,
             package_args=None):
     '''
-    .. version-added:: 2016.3.4
+    .. versionadded:: 2016.3.4
 
     Instructs Chocolatey to upgrade packages on the system. (update is being
     deprecated)

salt/modules/pushbullet.py

@@ -75,6 +75,7 @@ def push_note(device=None, title=None, body=None):
     CLI Example:
 
     .. code-block:: bash
+
         salt "*" pushbullet.push_note device="Chrome" title="Example title" body="Example body."
     '''
     spb = _SaltPushbullet(device)

salt/modules/sysfs.py

@@ -175,6 +175,7 @@ def interfaces(root):
 
     Output example:
      .. code-block:: json
+
        {
           "r": [
             "state",

salt/modules/vsphere.py

@@ -3579,6 +3579,7 @@ def add_host_to_dvs(host, username, password, vmknic_name, vmnic_name,
     Return Example:
 
     .. code-block:: yaml
+
         somehost:
             ----------
             esxi1.corp.com:

salt/returners/cassandra_cql_return.py

@@ -92,7 +92,8 @@ To use the cassandra returner, append '--return cassandra_cql' to the salt comma
 Note: if your Cassandra instance has not been tuned much you may benefit from
 altering some timeouts in `cassandra.yaml` like so:
 
-.. code-block:: bash
+.. code-block:: yaml
+
     # How long the coordinator should wait for read operations to complete
     read_request_timeout_in_ms: 5000
     # How long the coordinator should wait for seq or index scans to complete

salt/runners/survey.py

@@ -8,7 +8,7 @@ returned by several different minions.
 Aggregated results are sorted by the size of the minion pools which returned
 matching results.
 
-Useful for playing the game: " some of these things are not like the others... "
+Useful for playing the game: *"some of these things are not like the others..."*
 when identifying discrepancies in a large infrastructure managed by salt.
 '''
 
@@ -29,20 +29,20 @@ def hash(*args, **kwargs):
     .. versionadded:: 2014.7.0
 
     This command is submitted via a salt runner using the
-    general form:
+    general form::
 
         salt-run survey.hash [survey_sort=up/down] <target>
                   <salt-execution-module> <salt-execution-module parameters>
 
-    Optionally accept a "survey_sort=" parameter. Default: "survey_sort=down"
+    Optionally accept a ``survey_sort=`` parameter. Default: ``survey_sort=down``
 
-    CLI Example #1: ( functionally equivalent to "salt-run manage.up" )
+    CLI Example #1: (functionally equivalent to ``salt-run manage.up``)
 
     .. code-block:: bash
 
         salt-run survey.hash "*" test.ping
 
-    CLI Example #2: ( find an "outlier" minion config file )
+    CLI Example #2: (find an "outlier" minion config file)
 
     .. code-block:: bash
 
@@ -61,20 +61,23 @@ def diff(*args, **kwargs):
 
     These pools are determined from the aggregated and sorted results of
     a salt command.
-    This command displays the "diffs" as a series of 2-way differences-- namely
-    the difference between the FIRST displayed minion pool
-    (according to sort order) and EACH SUBSEQUENT minion pool result set.
-    Differences are displayed according to the Python "difflib.unified_diff()"
-    as in the case of the salt execution module "file.get_diff".
 
-    This command is submitted via a salt runner using the general form:
+    This command displays the "diffs" as a series of 2-way differences --
+    namely the difference between the FIRST displayed minion pool
+    (according to sort order) and EACH SUBSEQUENT minion pool result set.
+
+    Differences are displayed according to the Python ``difflib.unified_diff()``
+    as in the case of the salt execution module ``file.get_diff``.
+
+    This command is submitted via a salt runner using the general form::
 
         salt-run survey.diff [survey_sort=up/down] <target>
                      <salt-execution-module> <salt-execution-module parameters>
 
-    Optionally accept a "survey_sort=" parameter. Default: "survey_sort=down"
+    Optionally accept a ``survey_sort=`` parameter. Default:
+    ``survey_sort=down``
 
-    CLI Example #1: ( Example to display the "differences of files" )
+    CLI Example #1: (Example to display the "differences of files")
 
     .. code-block:: bash
 

salt/serializers/configparser.py

@@ -1,7 +1,7 @@
 # -*- coding: utf-8 -*-
 '''
     salt.serializers.configparser
-    ~~~~~~~~~~~~~~~~~~~~~~~~~~~
+    ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
     .. versionadded:: 2016.3.0
 

salt/states/boto_cloudtrail.py

@@ -1,7 +1,7 @@
 # -*- coding: utf-8 -*-
 '''
 Manage CloudTrail Objects
-=================
+=========================
 
 .. versionadded:: 2016.3.0
 

salt/states/boto_iot.py

@@ -1,7 +1,7 @@
 # -*- coding: utf-8 -*-
 '''
 Manage IoT Objects
-=================
+==================
 
 .. versionadded:: 2016.3.0
 

salt/states/boto_lambda.py

@@ -1,7 +1,7 @@
 # -*- coding: utf-8 -*-
 '''
 Manage Lambda Functions
-=================
+=======================
 
 .. versionadded:: 2016.3.0
 

salt/states/chronos_job.py

@@ -3,6 +3,7 @@
 Configure Chronos jobs via a salt proxy.
 
 .. code-block:: yaml
+
     my_job:
       chronos_job.config:
         - config:

salt/states/gpg.py

@@ -1,7 +1,7 @@
 # -*- coding: utf-8 -*-
 '''
 Management of the GPG keychains
-==============================
+===============================
 
 .. versionadded:: 2016.3.0
 

salt/states/mac_assistive.py

@@ -1,7 +1,7 @@
 # -*- coding: utf-8 -*-
 '''
 Allows you to manage assistive access on OS X minions with 10.9+
-=======================
+================================================================
 
 Install, enable and disable assitive access on OS X minions
 

salt/states/mac_defaults.py

@@ -1,7 +1,7 @@
 # -*- coding: utf-8 -*-
 '''
 Writing/reading defaults from an OS X minion
-=======================
+============================================
 
 '''
 

salt/states/mac_keychain.py

@@ -1,7 +1,7 @@
 # -*- coding: utf-8 -*-
 '''
 Installing of certificates to the keychain
-=======================
+==========================================
 
 Install certificats to the OS X keychain
 

salt/states/mac_xattr.py

@@ -1,7 +1,7 @@
 # -*- coding: utf-8 -*-
 '''
 Allows you to manage extended attributes on files or directories
-=======================
+================================================================
 
 Install, enable and disable assitive access on OS X minions
 

salt/states/marathon_app.py

@@ -3,6 +3,7 @@
 Configure Marathon apps via a salt proxy.
 
 .. code-block:: yaml
+
     my_app:
       marathon_app.config:
         - config:

salt/states/proxy.py

@@ -1,7 +1,7 @@
 # -*- coding: utf-8 -*-
 '''
 Allows you to manage proxy settings on minions
-=======================
+==============================================
 
 Setup proxy settings on minions
 

salt/states/win_certutil.py

@@ -1,7 +1,7 @@
 # -*- coding: utf-8 -*-
 '''
 Installing of certificates to the Windows Certificate Manager
-=======================
+=============================================================
 
 Install certificates to the Windows Certificate Manager
 

salt/states/win_dism.py

@@ -1,7 +1,7 @@
 # -*- coding: utf-8 -*-
 '''
 Installing of Windows features using DISM
-=======================
+=========================================
 
 Install windows features/capabilties with DISM
 

salt/states/win_license.py

@@ -1,7 +1,7 @@
 # -*- coding: utf-8 -*-
 '''
 Installation and activation of windows licenses
-=======================
+===============================================
 
 Install and activate windows licenses
 

salt/states/win_update.py

@@ -46,6 +46,7 @@ features/states of updates available for configuring:
 
 The following example installs all driver updates that don't require a reboot:
 .. code-block:: yaml
+
     gryffindor:
       win_update.installed:
         - skips:
@@ -56,6 +57,7 @@ The following example installs all driver updates that don't require a reboot:
 To just update your windows machine, add this your sls:
 
 .. code-block:: yaml
+
     updates:
       win_update.installed
 '''