Merge pull request #44420 from samodid/fix_docstrings_rendering

Fix docstrings rendering errors

doc/ref/configuration/master.rst

@@ -718,7 +718,7 @@ Note that ping_on_rotate may cause high load on the master immediately after
 the key rotation event as minions reconnect. Consider this carefully if this
 salt master is managing a large number of minions.
 
-.. code-black:: yaml
+.. code-block:: yaml
 
     ping_on_rotate: False
 
@@ -904,7 +904,7 @@ is set to ``tcp`` by default on Windows.
 
     ipc_mode: ipc
 
-.. conf_master::
+.. conf_master:: tcp_master_pub_port
 
 ``tcp_master_pub_port``
 -----------------------
@@ -4237,6 +4237,7 @@ Default: ``10``
 The number of workers for the runner/wheel in the reactor.
 
 .. code-block:: yaml
+
     reactor_worker_threads: 10
 
 .. conf_master:: reactor_worker_hwm

doc/ref/configuration/minion.rst

@@ -2387,6 +2387,7 @@ Default: ``10``
 The number of workers for the runner/wheel in the reactor.
 
 .. code-block:: yaml
+
     reactor_worker_threads: 10
 
 .. conf_minion:: reactor_worker_hwm

doc/ref/states/parallel.rst

@@ -51,7 +51,7 @@ actually speed things up.
 To run the above state much faster make sure that the ``sleep 5`` is evaluated
 before the ``nginx`` state
 
-.. code_block:: yaml
+.. code-block:: yaml
 
     sleep 10:
       cmd.run:

doc/topics/releases/oxygen.rst

@@ -174,11 +174,13 @@ to create it.
 The generated grain information will appear similar to:
 
 .. code-block:: yaml
+
     grains:
       salt-cloud:
         driver: ec2
         provider: my_ec2:ec2
         profile: ec2-web
+
 The generation of salt-cloud grains can be surpressed by the
 option ``enable_cloud_grains: 'False'`` in the cloud configuration file.
 

doc/topics/spm/master.rst

@@ -29,6 +29,7 @@ the name of the repository, and the link to the repository:
 For HTTP/HTTPS Basic authorization you can define credentials:
 
 .. code-block:: yaml
+
     my_repo:
       url: https://spm.example.com/
       username: user

doc/topics/spm/spm_formula.rst

@@ -164,7 +164,7 @@ states are evaluated before ``tgt`` states.
 Each of these sections needs to be evaluated as text, rather than as YAML. 
 Consider the following block:
 
-.. code-block::
+.. code-block:: text
 
     pre_local_state: >
       echo test > /tmp/spmtest:
@@ -187,7 +187,7 @@ a minion.
 the ``>`` marker to denote that the state is evaluated as text, not a data
 structure.
 
-.. code-block::
+.. code-block:: text
 
     pre_local_state: >
       echo test > /tmp/spmtest:
@@ -203,7 +203,7 @@ the ``spm`` command is running on is a master.
 Because ``tgt`` states require that a target be specified, their code blocks
 are a little different. Consider the following state:
 
-.. code-block::
+.. code-block:: text
 
     pre_tgt_state:
       tgt: '*'
@@ -229,7 +229,7 @@ This means that you can use Jinja or any other supported renderer inside of
 Salt. All formula variables are available to the renderer, so you can reference
 ``FORMULA`` data inside your state if you need to:
 
-.. code-block::
+.. code-block:: text
 
     pre_tgt_state:
       tgt: '*'

doc/topics/transports/tcp.rst

@@ -34,7 +34,7 @@ passing on a single socket.
 TLS Support
 ===========
 
-.. version_added:: 2016.11.1
+.. versionadded:: 2016.11.1
 
 The TCP transport allows for the master/minion communication to be optionally
 wrapped in a TLS connection. Enabling this is simple, the master and minion need

salt/cloud/clouds/vagrant.py

@@ -194,6 +194,7 @@ def create(vm_):
     CLI Example:
 
     .. code-block:: bash
+
         salt-cloud -p my_profile new_node_1
 
     '''

salt/cloud/clouds/virtualbox.py

@@ -198,7 +198,9 @@ def list_nodes_full(kwargs=None, call=None):
     This is because some functions both within Salt and 3rd party will break if an expected field is not present.
     This function is normally called with the -F option:
 
+
     .. code-block:: bash
+
         salt-cloud -F
 
 
@@ -244,6 +246,7 @@ def list_nodes(kwargs=None, call=None):
     This function is normally called with the -Q option:
 
     .. code-block:: bash
+
         salt-cloud -Q
 
 

salt/engines/ircbot.py

@@ -40,7 +40,7 @@ event <tag> [<extra>, <data>]
 
 Example of usage
 
-.. code:: txt
+.. code-block:: txt
 
     08:33:57 @gtmanfred > !ping
     08:33:57   gtmanbot > gtmanfred: pong
@@ -49,7 +49,7 @@ Example of usage
     08:34:17 @gtmanfred > !event test/tag/ircbot irc is usefull
     08:34:17   gtmanbot > gtmanfred: TaDa!
 
-.. code:: txt
+.. code-block:: txt
 
     [DEBUG   ] Sending event: tag = salt/engines/ircbot/test/tag/ircbot; data = {'_stamp': '2016-11-28T14:34:16.633623', 'data': [u'irc', u'is', u'usefull']}
 

salt/modules/boto_apigateway.py

@@ -2,7 +2,7 @@
 '''
 Connection module for Amazon APIGateway
 
-.. versionadded::
+.. versionadded:: 2016.11.0
 
 :configuration: This module accepts explicit Lambda credentials but can also
     utilize IAM roles assigned to the instance trough Instance Profiles.

salt/modules/boto_ec2.py

@@ -1747,6 +1747,7 @@ def set_volumes_tags(tag_maps, authoritative=False, dry_run=False,
     YAML example fragment:
 
     .. code-block:: yaml
+
         - filters:
             attachment.instance_id: i-abcdef12
           tags:

salt/modules/boto_efs.py

@@ -156,7 +156,7 @@ def create_file_system(name,
 
     CLI Example:
 
-    .. code-block::
+    .. code-block:: bash
 
         salt 'my-minion' boto_efs.create_file_system efs-name generalPurpose
     '''
@@ -222,7 +222,7 @@ def create_mount_target(filesystemid,
 
     CLI Example:
 
-    .. code-block::
+    .. code-block:: bash
 
         salt 'my-minion' boto_efs.create_mount_target filesystemid subnetid
     '''
@@ -269,7 +269,7 @@ def create_tags(filesystemid,
 
     CLI Example:
 
-    .. code-block::
+    .. code-block:: bash
 
         salt 'my-minion' boto_efs.create_tags
     '''
@@ -301,7 +301,7 @@ def delete_file_system(filesystemid,
 
     CLI Example:
 
-    .. code-block::
+    .. code-block:: bash
 
         salt 'my-minion' boto_efs.delete_file_system filesystemid
     '''
@@ -335,7 +335,7 @@ def delete_mount_target(mounttargetid,
 
     CLI Example:
 
-    .. code-block::
+    .. code-block:: bash
 
         salt 'my-minion' boto_efs.delete_mount_target mounttargetid
     '''
@@ -363,7 +363,7 @@ def delete_tags(filesystemid,
 
     CLI Example:
 
-    .. code-block::
+    .. code-block:: bash
 
         salt 'my-minion' boto_efs.delete_tags
     '''
@@ -398,7 +398,7 @@ def get_file_systems(filesystemid=None,
 
     CLI Example:
 
-    .. code-block::
+    .. code-block:: bash
 
         salt 'my-minion' boto_efs.get_file_systems efs-id
     '''
@@ -454,7 +454,7 @@ def get_mount_targets(filesystemid=None,
 
     CLI Example:
 
-    .. code-block::
+    .. code-block:: bash
 
         salt 'my-minion' boto_efs.get_mount_targets
     '''
@@ -493,7 +493,7 @@ def get_tags(filesystemid,
 
     CLI Example:
 
-    .. code-block::
+    .. code-block:: bash
 
         salt 'my-minion' boto_efs.get_tags efs-id
     '''
@@ -527,7 +527,7 @@ def set_security_groups(mounttargetid,
 
     CLI Example:
 
-    .. code-block::
+    .. code-block:: bash
 
         salt 'my-minion' boto_efs.set_security_groups my-mount-target-id my-sec-group
     '''

salt/modules/defaults.py

@@ -1,4 +1,9 @@
 # -*- coding: utf-8 -*-
+'''
+Module to work with salt formula defaults files
+
+'''
+
 from __future__ import absolute_import
 import json
 import logging

salt/modules/grains.py

@@ -413,6 +413,7 @@ def delkey(key):
     CLI Example:
 
     .. code-block:: bash
+
         salt '*' grains.delkey key
     '''
     setval(key, None, destructive=True)

salt/modules/jenkins.py

@@ -112,7 +112,7 @@ def run(script):
 
     CLI Example:
 
-    .. code-block::
+    .. code-block:: bash
 
         salt '*' jenkins.run 'Jenkins.instance.doSafeRestart()'
 

salt/modules/kubernetes.py

@@ -28,6 +28,7 @@ For an item only one field should be provided. Either a `data` or a `file` entry
 In case both are provided the `file` entry is prefered.
 
 .. code-block:: bash
+
     salt '*' kubernetes.nodes api_url=http://k8s-api-server:port api_user=myuser api_password=pass
 
 .. versionadded: 2017.7.0

salt/modules/mac_shadow.py

@@ -1,8 +1,8 @@
 # -*- coding: utf-8 -*-
 '''
-.. versionadded:: 2016.3.0
+Manage macOS local directory passwords and policies
 
-Manage macOS local directory passwords and policies.
+.. versionadded:: 2016.3.0
 
 Note that it is usually better to apply password policies through the creation
 of a configuration profile.

salt/modules/mac_system.py

@@ -1,9 +1,8 @@
 # -*- coding: utf-8 -*-
 '''
-.. versionadded:: 2016.3.0
+System module for sleeping, restarting, and shutting down the system on Mac OS X
 
-System module for sleeping, restarting, and shutting down the system on Mac OS
-X.
+.. versionadded:: 2016.3.0
 
 .. warning::
     Using this module will enable ``atrun`` on the system if it is disabled.

salt/modules/nacl.py

@@ -85,6 +85,7 @@ without extra parameters:
     salt-run nacl.dec 'tqXzeIJnTAM9Xf0mdLcpEdklMbfBGPj2oTKmlgrm3S1DTVVHNnh9h8mU1GKllGq/+cYsk6m5WhGdk58='
 
 .. code-block:: yam
+
     # a salt developers minion could have pillar data that includes a nacl public key
     nacl.config:
         pk: '/kfGX7PbWeu099702PBbKWLpG/9p06IQRswkdWHCDk0='

salt/modules/namecheap_dns.py

@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 '''
- Namecheap management
+Namecheap dns management
 
 .. versionadded:: 2017.7.0
 
@@ -17,6 +17,7 @@
    the namecheap API:
 
         * ``requests``
+
         .. code-block:: bash
 
             pip install requests

salt/modules/namecheap_domains.py

@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 '''
- Namecheap management
+Namecheap domains management
 
  .. versionadded:: 2017.7.0
 
@@ -73,7 +73,7 @@ def reactivate(domain_name):
 
     CLI Example:
 
-    .. code-block::
+    .. code-block:: bash
 
         salt 'my-minion' namecheap_domains.reactivate my-domain-name
 

salt/modules/namecheap_ns.py

@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 '''
- Namecheap management
+Namecheap nameservers management
 
 .. versionadded:: 2017.7.0
 
@@ -17,6 +17,7 @@
    the namecheap API:
 
         * ``requests``
+
         .. code-block:: bash
 
             pip install requests

salt/modules/namecheap_ssl.py

@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 '''
- Namecheap management
+Namecheap ssl management
 
  .. versionadded:: 2017.7.0
 
@@ -110,7 +110,7 @@ def reissue(csr_file,
 
     CLI Example:
 
-    .. code-block::
+    .. code-block:: bash
 
         salt 'my-minion' namecheap_ssl.reissue my-csr-file my-cert-id apachessl
     '''
@@ -164,7 +164,7 @@ def activate(csr_file,
 
     CLI Example:
 
-    .. code-block::
+    .. code-block:: bash
 
         salt 'my-minion' namecheap_ssl.activate my-csr-file my-cert-id apachessl
     '''
@@ -298,7 +298,7 @@ def renew(years, certificate_id, certificate_type, promotion_code=None):
 
     CLI Example:
 
-    .. code-block::
+    .. code-block:: bash
 
         salt 'my-minion' namecheap_ssl.renew 1 my-cert-id RapidSSL
     '''
@@ -460,7 +460,7 @@ Symantec  Secure Site                      1                 25              24
 
     CLI Example:
 
-    .. code-block::
+    .. code-block:: bash
 
         salt 'my-minion' namecheap_ssl.create 2 RapidSSL
     '''
@@ -557,7 +557,7 @@ def parse_csr(csr_file, certificate_type, http_dc_validation=False):
 
     CLI Example:
 
-    .. code-block::
+    .. code-block:: bash
 
         salt 'my-minion' namecheap_ssl.parse_csr my-csr-file PremiumSSL
     '''
@@ -644,7 +644,7 @@ def get_list(**kwargs):
 
     CLI Example:
 
-    .. code-block::
+    .. code-block:: bash
 
         salt 'my-minion' namecheap_ssl.get_list Processing
     '''
@@ -688,7 +688,7 @@ def get_info(certificate_id, returncertificate=False, returntype=None):
 
     CLI Example:
 
-    .. code-block::
+    .. code-block:: bash
 
         salt 'my-minion' namecheap_ssl.get_info my-cert-id
     '''

salt/modules/namecheap_users.py

@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 '''
- Namecheap management
+Namecheap users management
 
  .. versionadded:: 2017.7.0
 

salt/modules/napalm_network.py

@@ -500,7 +500,7 @@ def cli(*commands, **kwargs):  # pylint: disable=unused-argument
 
     CLI Example with TextFSM template:
 
-    .. code-block::
+    .. code-block:: bash
 
         salt '*' net.cli textfsm_parse=True textfsm_path=salt://textfsm/
 
@@ -1238,6 +1238,7 @@ def load_config(filename=None,
     Example output:
 
     .. code-block:: python
+
         {
             'comment': 'Configuration discarded.',
             'already_configured': False,

salt/modules/openscap.py

@@ -1,4 +1,9 @@
 # -*- coding: utf-8 -*-
+'''
+Module for OpenSCAP Management
+
+'''
+
 from __future__ import absolute_import
 import tempfile
 import shlex

salt/modules/parallels.py

@@ -10,7 +10,7 @@ What has not been implemented yet can be accessed through ``parallels.prlctl``
 and ``parallels.prlsrvctl`` (note the preceding double dash ``--`` as
 necessary):
 
-.. code-block::
+.. code-block:: bash
 
     salt '*' parallels.prlctl installtools macvm runas=macdev
     salt -- '*' parallels.prlctl capture 'macvm --file macvm.display.png' runas=macdev

salt/modules/reg.py

@@ -1,8 +1,6 @@
 # -*- coding: utf-8 -*-
 '''
-===========================
 Manage the Windows registry
-===========================
 
 -----
 Hives

salt/modules/snapper.py

@@ -229,6 +229,7 @@ def set_config(name='root', **kwargs):
     snapper convention. The above example is equivalent to:
 
     .. code-block:: bash
+
         salt '*' snapper.set_config sync_acl=True
     '''
     try:

salt/modules/tomcat.py

@@ -186,7 +186,7 @@ def extract_war_version(war):
 
     Examples:
 
-    .. code-block::
+    .. code-block:: text
 
         /path/salt-2015.8.6.war -> 2015.8.6
         /path/V6R2013xD5.war -> None

salt/modules/udev.py

@@ -170,6 +170,7 @@ def exportdb():
     CLI Example:
 
     .. code-block:: bash
+
         salt '*' udev.exportdb
     '''
 

salt/modules/vault.py

@@ -1,13 +1,16 @@
 # -*- coding: utf-8 -*-
 '''
+Functions to interact with Hashicorp Vault.
+
 :maintainer:    SaltStack
 :maturity:      new
 :platform:      all
 
-Functions to interact with Hashicorp Vault.
 
 :note: If you see the following error, you'll need to upgrade ``requests`` to atleast 2.4.2
-.. code-block:: shell
+
+.. code-block:: text
+
     <timestamp> [salt.pillar][CRITICAL][14337] Pillar render error: Failed to load ext_pillar vault: {'error': "request() got an unexpected keyword argument 'json'"}
 
 
@@ -151,6 +154,7 @@ def write_secret(path, **kwargs):
     CLI Example:
 
     .. code-block:: bash
+
             salt '*' vault.write_secret "secret/my/secret" user="foo" password="bar"
     '''
     log.debug(
@@ -176,6 +180,7 @@ def delete_secret(path):
     CLI Example:
 
     .. code-block:: bash
+
             salt '*' vault.delete_secret "secret/my/secret"
     '''
     log.debug('Deleting vault secrets for {0} in {1}'
@@ -199,6 +204,7 @@ def list_secrets(path):
     CLI Example:
 
     .. code-block:: bash
+
             salt '*' vault.list_secrets "secret/my/"
     '''
     log.debug('Listing vault secret keys for {0} in {1}'

salt/modules/vsphere.py

@@ -4211,6 +4211,7 @@ def list_dvportgroups(dvs=None, portgroup_names=None, service_instance=None):
         Default is None.
 
     .. code-block:: bash
+
         salt '*' vsphere.list_dvporgroups
 
         salt '*' vsphere.list_dvportgroups dvs=dvs1
@@ -4662,6 +4663,7 @@ def list_storage_policies(policy_names=None, service_instance=None):
         Default is None.
 
     .. code-block:: bash
+
         salt '*' vsphere.list_storage_policies
 
         salt '*' vsphere.list_storage_policy policy_names=[policy_name]
@@ -4688,6 +4690,7 @@ def list_default_vsan_policy(service_instance=None):
         Default is None.
 
     .. code-block:: bash
+
         salt '*' vsphere.list_storage_policies
 
         salt '*' vsphere.list_storage_policy policy_names=[policy_name]
@@ -4726,6 +4729,7 @@ def list_capability_definitions(service_instance=None):
         Default is None.
 
     .. code-block:: bash
+
         salt '*' vsphere.list_capabilities
     '''
     profile_manager = salt.utils.pbm.get_profile_manager(service_instance)
@@ -4806,6 +4810,7 @@ def create_storage_policy(policy_name, policy_dict, service_instance=None):
         Default is None.
 
     .. code-block:: bash
+
         salt '*' vsphere.create_storage_policy policy_name='policy name'
             policy_dict="$policy_dict"
     '''
@@ -4845,6 +4850,7 @@ def update_storage_policy(policy, policy_dict, service_instance=None):
         Default is None.
 
     .. code-block:: bash
+
         salt '*' vsphere.update_storage_policy policy='policy name'
             policy_dict="$policy_dict"
     '''
@@ -4882,6 +4888,7 @@ def list_default_storage_policy_of_datastore(datastore, service_instance=None):
         Default is None.
 
     .. code-block:: bash
+
         salt '*' vsphere.list_default_storage_policy_of_datastore datastore=ds1
     '''
     log.trace('Listing the default storage policy of datastore \'{0}\''
@@ -4920,6 +4927,7 @@ def assign_default_storage_policy_to_datastore(policy, datastore,
         Default is None.
 
     .. code-block:: bash
+
         salt '*' vsphere.assign_storage_policy_to_datastore
             policy='policy name' datastore=ds1
     '''
@@ -4964,6 +4972,7 @@ def list_datacenters_via_proxy(datacenter_names=None, service_instance=None):
         Default is None.
 
     .. code-block:: bash
+
         salt '*' vsphere.list_datacenters_via_proxy
 
         salt '*' vsphere.list_datacenters_via_proxy dc1

salt/modules/win_dsc.py

@@ -1,9 +1,9 @@
 # -*- coding: utf-8 -*-
 '''
-This module is Alpha
-
 Module for working with Windows PowerShell DSC (Desired State Configuration)
 
+This module is Alpha
+
 This module applies DSC Configurations in the form of PowerShell scripts or
 MOF (Managed Object Format) schema files.
 

salt/modules/zk_concurrency.py

@@ -1,11 +1,11 @@
 # -*- coding: utf-8 -*-
 '''
-:depends: kazoo
-:configuration: See :py:mod:`salt.modules.zookeeper` for setup instructions.
-
 Concurrency controls in zookeeper
 =========================================================================
 
+:depends: kazoo
+:configuration: See :py:mod:`salt.modules.zookeeper` for setup instructions.
+
 This module allows you to acquire and release a slot. This is primarily useful
 for ensureing that no more than N hosts take a specific action at once. This can
 also be used to coordinate between masters.

salt/modules/zookeeper.py

@@ -34,6 +34,7 @@ Configuration
     be set up as different configuration profiles. For example:
 
     .. code-block:: yaml
+
         zookeeper:
           prod:
             hosts: zoo1,zoo2,zoo3

salt/netapi/rest_cherrypy/app.py

@@ -71,12 +71,12 @@ A REST API for Salt
     log_access_file
         Path to a file to write HTTP access logs.
 
-        .. versionaddedd:: 2016.11.0
+        .. versionadded:: 2016.11.0
 
     log_error_file
         Path to a file to write HTTP error logs.
 
-        .. versionaddedd:: 2016.11.0
+        .. versionadded:: 2016.11.0
 
     ssl_crt
         The path to a SSL certificate. (See below)

salt/pillar/csvpillar.py

@@ -2,7 +2,7 @@
 '''
 Store key/value pairs in a CSV file
 
-.. versionaddedd:: 2016.11.0
+.. versionadded:: 2016.11.0
 
 Example configuration:
 

salt/pillar/nodegroups.py

@@ -16,6 +16,7 @@ Command Line
 ------------
 
 .. code-block:: bash
+
     salt-call pillar.get nodegroups
     local:
         - class_infra

salt/runners/jobs.py

@@ -466,7 +466,9 @@ def exit_success(jid, ext_source=None):
         The external job cache to use. Default: `None`.
 
     CLI Example:
+
     .. code-block:: bash
+
         salt-run jobs.exit_success 20160520145827701627
     '''
     ret = dict()

salt/runners/nacl.py

@@ -85,6 +85,7 @@ without extra parameters:
     salt-run nacl.dec 'tqXzeIJnTAM9Xf0mdLcpEdklMbfBGPj2oTKmlgrm3S1DTVVHNnh9h8mU1GKllGq/+cYsk6m5WhGdk58='
 
 .. code-block:: yam
+
     # a salt developers minion could have pillar data that includes a nacl public key
     nacl.config:
         pk: '/kfGX7PbWeu099702PBbKWLpG/9p06IQRswkdWHCDk0='

salt/runners/test.py

@@ -85,7 +85,7 @@ def get_opts():
 
     CLI Example:
 
-    .. code-block::
+    .. code-block:: bash
 
         salt-run test.get_opts
     '''

salt/sdb/consul.py

@@ -13,6 +13,7 @@ be configured in either the minion or master configuration file. This profile
 requires very little. For example:
 
 .. code-block:: yaml
+
     myconsul:
       driver: consul
       host: 127.0.0.1

salt/states/boto_apigateway.py

@@ -124,7 +124,9 @@ def present(name, api_name, swagger_file, stage_name, api_key_required,
     with the following schema.  The lambda functions should throw exceptions for any non successful responses.
     An optional pattern field can be specified in errorMessage field to aid the response mapping from Lambda
     to the proper error return status codes.
+
         .. code-block:: yaml
+
             Error:
               type: object
               properties:

salt/states/boto_ec2.py

@@ -984,7 +984,7 @@ def instance_absent(name, instance_name=None, instance_id=None,
     '''
     Ensure an EC2 instance does not exist (is stopped and removed).
 
-    .. versionupdated:: 2016.11.0
+    .. versionchanged:: 2016.11.0
 
     name
         (string) - The name of the state definition.
@@ -1010,6 +1010,7 @@ def instance_absent(name, instance_name=None, instance_id=None,
     YAML example fragment:
 
     .. code-block:: yaml
+
         - filters:
             vpc-id: vpc-abcdef12
 
@@ -1230,6 +1231,7 @@ def volumes_tagged(name, tag_maps, authoritative=False, region=None, key=None,
     YAML example fragment:
 
     .. code-block:: yaml
+
         - filters:
             attachment.instance_id: i-abcdef12
           tags:

salt/states/boto_iam.py

@@ -1636,7 +1636,7 @@ def policy_absent(name,
 def saml_provider_present(name, saml_metadata_document, region=None, key=None, keyid=None, profile=None):
     '''
 
-    .. versionadded::
+    .. versionadded:: 2016.11.0
 
     Ensure the SAML provider with the specified name is present.
 
@@ -1694,7 +1694,7 @@ def saml_provider_present(name, saml_metadata_document, region=None, key=None, k
 def saml_provider_absent(name, region=None, key=None, keyid=None, profile=None):
     '''
 
-    .. versionadded::
+    .. versionadded:: 2016.11.0
 
     Ensure the SAML provider with the specified name is absent.
 

salt/states/boto_lambda.py

@@ -153,6 +153,7 @@ def function_present(name, FunctionName, Runtime, Role, Handler, ZipFile=None,
         to the same VPC.  This is a dict of the form:
 
         .. code-block:: yaml
+
             VpcConfig:
                 SecurityGroupNames:
                 - mysecgroup1

salt/states/csf.py

@@ -1,7 +1,4 @@
 # -*- coding: utf-8 -*-
-from __future__ import absolute_import
-from salt.ext.six.moves import map
-
 '''
 CSF Ip tables management
 ========================
@@ -18,6 +15,9 @@ CSF Ip tables management
         method: allow
 '''  # pylint: disable=W0105
 
+from __future__ import absolute_import
+from salt.ext.six.moves import map
+
 
 def __virtual__():
     return 'csf'

salt/states/docker_container.py

@@ -1235,6 +1235,7 @@ def running(name,
         If ``True``, runs the exec process with extended privileges
 
         .. code-block:: yaml
+
             foo:
               docker_container.running:
                 - image: bar/baz:lates

salt/states/elasticsearch_index.py

@@ -65,6 +65,7 @@ def present(name, definition=None):
     **Example:**
 
     .. code-block:: yaml
+
         # Default settings
         mytestindex:
           elasticsearch_index.present

salt/states/elasticsearch_index_template.py

@@ -65,6 +65,7 @@ def present(name, definition):
     **Example:**
 
     .. code-block:: yaml
+
         mytestindex2_template:
           elasticsearch_index_template.present:
             - definition:

salt/states/etcd_mod.py

@@ -45,6 +45,7 @@ Etcd profile configuration can be overriden using following arguments: ``host``,
 ``port``, ``username``, ``password``, ``ca``, ``client_key`` and ``client_cert``.
 
 .. code-block:: yaml
+
     my-value:
       etcd.set:
         - name: /path/to/key

salt/states/libcloud_loadbalancer.py

@@ -34,6 +34,7 @@ Example:
 Using States to deploy a load balancer with extended arguments to specify region
 
 .. code-block:: yaml
+
     lb_test:
         libcloud_loadbalancer.balancer_present:
             - name: example

salt/states/mac_package.py

@@ -91,6 +91,7 @@ def installed(name, target="LocalSystem", dmg=False, store=False, app=False, mpk
         The command and version that we want to check against, the version number can use regex.
 
         .. code-block:: yaml
+
             version_check: python --version_check=2.7.[0-9]
 
     '''

salt/states/msteams.py

@@ -2,6 +2,7 @@
 '''
 Send a message card to Microsoft Teams
 =======================
+
 This state is useful for sending messages to Teams during state runs.
 .. versionadded:: 2017.7.0
 .. code-block:: yaml

salt/states/reg.py

@@ -1,8 +1,8 @@
 # -*- coding: utf-8 -*-
 r'''
-===========================
 Manage the Windows registry
 ===========================
+
 Many python developers think of registry keys as if they were python keys in a
 dictionary which is not the case. The windows registry is broken down into the
 following components:

salt/states/sysrc.py

@@ -1,4 +1,8 @@
 # -*- coding: utf-8 -*-
+'''
+State to work with sysrc
+
+'''
 
 # Import Python libs
 from __future__ import absolute_import

salt/states/telemetry_alert.py

@@ -1,10 +1,10 @@
 # -*- coding: utf-8 -*-
 '''
-.. versionadded:: 2016.3.0.
-
 Manage Telemetry alert configurations
 =====================================
 
+.. versionadded:: 2016.3.0
+
 Create, Update and destroy Mongo Telemetry alert configurations.
 
 This module uses requests, which can be installed via package, or pip.

salt/states/vagrant.py

@@ -1,10 +1,10 @@
 # -*- coding: utf-8 -*-
 r'''
-.. index:: Vagrant state function
-
 Manage Vagrant VMs
 ==================
 
+.. index:: Vagrant state function
+
 Manange execution of Vagrant virtual machines on Salt minions.
 
 Vagrant_ is a tool for building and managing virtual machine environments.

salt/states/vault.py

@@ -1,13 +1,14 @@
 # -*- coding: utf-8 -*-
 '''
+States for managing Hashicorp Vault.
+Currently handles policies. Configuration instructions are documented in the execution module docs.
+
 :maintainer:    SaltStack
 :maturity:      new
 :platform:      all
 
 .. versionadded:: 2017.7.0
 
-States for managing Hashicorp Vault. Currently handles policies. Configuration
-instructions are documented in the execution module docs.
 '''
 from __future__ import absolute_import
 import logging

salt/states/zk_concurrency.py

@@ -1,10 +1,11 @@
 # -*- coding: utf-8 -*-
 '''
+Control concurrency of steps within state execution using zookeeper
+===================================================================
+
 :depends: kazoo
 :configuration: See :py:mod:`salt.modules.zookeeper` for setup instructions.
 
-Control concurrency of steps within state execution using zookeeper
-===================================================================
 
 This module allows you to "wrap" a state's execution with concurrency control.
 This is useful to protect against all hosts executing highstate simultaneously