Merge pull request #27416 from rallytime/bp-27399

Back-port #27399 to 2015.8

doc/ref/states/top.rst

@@ -317,9 +317,10 @@ For the following discussion of top file compilation, assume the following
 configuration:
 
 
-``/etc/salt/master``
+``/etc/salt/master``:
 
 .. code-block:: yaml
+
     <snip>
     file_roots:
       first_env:
@@ -328,7 +329,8 @@ configuration:
         - /srv/salt/second
 
 
-``/srv/salt/first/top.sls:``
+``/srv/salt/first/top.sls``:
+
 .. code-block:: yaml
 
     first_env:

doc/topics/transports/raet/index.rst

@@ -32,9 +32,9 @@ Using RAET in Salt
 
 Using RAET in Salt is easy, the main difference is that the core dependencies
 change, instead of needing pycrypto, M2Crypto, ZeroMQ, and PYZMQ, the packages
-libsodium, libnacl, ioflo, and raet are required. Encryption is handled very cleanly
+`libsodium`_, libnacl, ioflo, and raet are required. Encryption is handled very cleanly
 by libnacl, while the queueing and flow control is handled by
-ioflo. Distribution packages are forthcoming, but libsodium can be easily
+ioflo. Distribution packages are forthcoming, but `libsodium`_ can be easily
 installed from source, or many distributions do ship packages for it.
 The libnacl and ioflo packages can be easily installed from pypi, distribution
 packages are in the works.
@@ -129,18 +129,17 @@ Salt is not dropping ZeroMQ support and has no immediate plans to do so.
 Encryption
 ==========
 
-RAET uses Dan Bernstein's NACL encryption libraries and CurveCP handshake.
-The libnacl python binding binds to both libsodium and tweetnacl to execute
+RAET uses Dan Bernstein's NACL encryption libraries and `CurveCP`_ handshake.
+The libnacl python binding binds to both `libsodium`_ and tweetnacl to execute
 the underlying cryptography. This allows us to completely rely on an
 externally developed cryptography system.
 
-For more information on libsodium and CurveCP please see:
-http://doc.libsodium.org/
-http://curvecp.org/
-
 Programming Intro
 =================
 
-.. toctree:
+.. toctree::
 
    programming_intro
+
+.. _libsodium: http://doc.libsodium.org/
+.. _CurveCP: http://curvecp.org/

doc/topics/transports/raet/programming_intro.rst

@@ -1,4 +1,4 @@
-.. _raet_programming:
+.. _raet-programming:
 
 =========================
 Intro to RAET Programming

salt/modules/consul.py

@@ -160,13 +160,15 @@ def get(consul_url=None, key=None, recurse=False, decode=False, raw=False):
 
         salt '*' consul.list key='web' recurse='True' decode='True'
 
-        By default values stored in Consul are base64 encoded, passing the
-        decode option will show them as the decoded values.
+    By default values stored in Consul are base64 encoded, passing the
+    decode option will show them as the decoded values.
+
+    .. code-block:: bash
 
         salt '*' consul.list key='web' recurse='True' decode='True' raw='True'
 
-        By default Consult will return other information about the key, the raw
-        option will return only the raw value.
+    By default Consult will return other information about the key, the raw
+    option will return only the raw value.
 
     '''
     ret = {}

salt/renderers/jinja.py

@@ -169,9 +169,9 @@ yaml_encode
       baz: {{ zap|yaml_encode }}
       {%- endload %}
 
-   In the above case ``{{ bar }}`` and ``{{ foo.bar }}`` should be
-   identical and ``{{ baz }}`` and ``{{ foo.baz }}`` should be
-   identical.
+  In the above case ``{{ bar }}`` and ``{{ foo.bar }}`` should be
+  identical and ``{{ baz }}`` and ``{{ foo.baz }}`` should be
+  identical.
 
 yaml_dquote
   Serializes a string into a properly-escaped YAML double-quoted
@@ -190,11 +190,11 @@ yaml_dquote
       baz: {{ baz|yaml_dquote }}
       {%- endload %}
 
-   In the above case ``{{ bar }}`` and ``{{ foo.bar }}`` should be
-   identical and ``{{ baz }}`` and ``{{ foo.baz }}`` should be
-   identical.  If variable contents are not guaranteed to be a string
-   then it is better to use ``yaml_encode`` which handles all YAML
-   scalar types.
+  In the above case ``{{ bar }}`` and ``{{ foo.bar }}`` should be
+  identical and ``{{ baz }}`` and ``{{ foo.baz }}`` should be
+  identical.  If variable contents are not guaranteed to be a string
+  then it is better to use ``yaml_encode`` which handles all YAML
+  scalar types.
 
 yaml_squote
    Similar to the ``yaml_dquote`` filter but with single quotes.  Note

salt/states/blockdev.py

@@ -12,8 +12,8 @@ A state module to manage blockdevices
         - read-only: True
 
     master-data:
-      blockdev.tuned::
-        - name : /dev/vg/master-data
+      blockdev.tuned:
+        - name: /dev/vg/master-data
         - read-only: True
         - read-ahead: 1024
 

salt/states/boto_elb.py

@@ -229,10 +229,10 @@ def present(
         profile=None,
         wait_for_sync=True):
     '''
-    Ensure the IAM role exists.
+    Ensure the ELB exists.
 
     name
-        Name of the IAM role.
+        Name of the ELB.
 
     availability_zones
         A list of availability zones for this ELB.

salt/states/dockerio.py

@@ -82,7 +82,7 @@ Available Functions
 
   .. note::
 
-      The ``port_bindings`` argument above is a dictionary. The double
+      The ``ports`` argument above is a dictionary. The double
       indentation is required for PyYAML to load the data structure
       properly as a python dictionary. More information can be found
       :ref:`here <nested-dict-indentation>`
@@ -479,21 +479,14 @@ def loaded(name, tag='latest', source=None, source_hash='', force=False):
 
         .. note::
 
-            See first the documentation for salt file.managed
-            <http://docs.saltstack.com/en/latest/ref/states/all/_
-            salt.states.file.html#salt.states.file.managed>
+            See first the documentation for Salt `file.managed
+            <http://docs.saltstack.com/en/latest/ref/states/all/salt.states.file.html#salt.states.file.managed>`_
 
     source_hash
         This can be one of the following:
             1. a source hash string
             2. the URI of a file that contains source hash strings
 
-            .. note::
-
-                See first the documentation for salt file.managed
-                <http://docs.saltstack.com/en/latest/ref/states/all/_
-                salt.states.file.html#salt.states.file.managed>
-
     force
         Load even if the image exists
     '''
@@ -645,9 +638,8 @@ def installed(name,
         List of volumes (see notes for the running function)
 
     For other parameters, see absolutely first the salt.modules.dockerio
-    execution module and the docker-py python bindings for docker
-    documentation
-    <https://github.com/dotcloud/docker-py#api>`_ for
+    execution module and the `docker-py python bindings for docker
+    documentation <https://github.com/dotcloud/docker-py#api>`_ for
     `docker.create_container`.
 
     .. note::

salt/states/etcd_mod.py

@@ -17,6 +17,7 @@ To work with an etcd server you must configure an etcd profile in the Salt
 Master configuration, for example:
 
 .. code-block:: yaml
+
     my_etd_config:
       etcd.host: 127.0.0.1
       etcd.port: 4001
@@ -25,6 +26,7 @@ You can also configure etcd without a profile however it is recommended that
 you use profiles:
 
 .. code-block:: yaml
+
     etcd.host: 127.0.0.1
     etcd.port: 4001
 
@@ -38,6 +40,7 @@ Available Functions
   means you can watch these states for changes.
 
   .. code-block:: yaml
+
       /foo/bar/baz:
         etcd.set:
           - value: foo
@@ -45,7 +48,7 @@ Available Functions
 
 - ``wait_set``
 
-  Performs the same functionality as``set`` but only if a watch requisite is ``True``.
+  Performs the same functionality as ``set`` but only if a watch requisite is ``True``.
 
   .. code-block:: yaml
 
@@ -67,13 +70,14 @@ Available Functions
   not exist then no changes will occur.
 
   .. code-block:: yaml
+
       /foo/bar/baz:
         etcd.rm:
           - profile: my_etcd_config
 
 - ``wait_rm``
 
-  Performs the same functionality as``rm`` but only if a watch requisite is ``True``.
+  Performs the same functionality as ``rm`` but only if a watch requisite is ``True``.
 
   .. code-block:: yaml
 

salt/states/hipchat.py

@@ -18,6 +18,7 @@ This state is useful for sending messages to Hipchat during state runs.
         - api_version: v1
 
 The api key can be specified in the master or minion configuration like below:
+
 .. code-block:: yaml
 
     hipchat: