Fixing more sphinx/docs errors and warnings

doc/ref/modules/all/salt.modules.x509.rst

@@ -1,6 +1,6 @@
-================
+=================
 salt.modules.x509
-================
+=================
 
 .. automodule:: salt.modules.x509
     :members:

doc/security/index.rst

@@ -103,7 +103,7 @@ quickly and safely as is possible.
     the full release documentation and download locations.
 
 Receiving security announcements
-===============================
+================================
 
 The fastest place to receive security announcements is via the `salt-announce`_
-mailing list. This list is low-traffic.
+mailing list. This list is low-traffic.

doc/topics/installation/debian.rst

@@ -11,7 +11,7 @@ Configure Apt
 
 
 Squeeze (Old Old Stable)
---------------------
+------------------------
 
 For squeeze, you will need to enable the Debian backports repository
 as well as the debian.saltstack.com repository. To do so, add the
@@ -26,7 +26,7 @@ following to ``/etc/apt/sources.list`` or a file in
 
 
 Wheezy (Old Stable)
----------------
+-------------------
 
 For wheezy, the following line is needed in either
 ``/etc/apt/sources.list`` or a file in ``/etc/apt/sources.list.d``:
@@ -36,7 +36,7 @@ For wheezy, the following line is needed in either
     deb http://debian.saltstack.com/debian wheezy-saltstack main
 
 Jessie (Stable)
-----------------
+---------------
 
 For jessie, the following line is needed in either
 ``/etc/apt/sources.list`` or a file in ``/etc/apt/sources.list.d``:

doc/topics/transports/tcp.rst

@@ -15,6 +15,7 @@ in the future. That being said, the wire framing is quite efficient and looks
 like:
 
 .. code-block:: text
+
     len(payload) msgpack({'head': SOMEHEADER, 'body': SOMEBODY})
 
 The wire protocol is basically two parts, the length of the payload and a payload
@@ -36,6 +37,7 @@ For the pub channel we send messages without "message ids" which the remote end
 interprets as a one-way send.
 
 .. note::
+
     As of today we send all publishes to all minions and rely on minion-side filtering.
 
 

salt/modules/boto_iam.py

@@ -1208,8 +1208,7 @@ def upload_server_cert(cert_name, cert_body, private_key, cert_chain=None, path=
     :param cert_name: The name for the server certificate. Do not include the path in this value.
     :param cert_body: The contents of the public key certificate in PEM-encoded format.
     :param private_key: The contents of the private key in PEM-encoded format.
-    :param cert_chain:  The contents of the certificate chain. This is typically a
-    concatenation of the PEM-encoded public key certificates of the chain.
+    :param cert_chain:  The contents of the certificate chain. This is typically a concatenation of the PEM-encoded public key certificates of the chain.
     :param path: The path for the server certificate.
     :param region: The name of the region to connect to.
     :param key: The key to be used in order to connect

salt/modules/win_status.py

@@ -167,7 +167,7 @@ def saltmem(human_readable=False):
 
     CLI Example:
 
-    .. code-black:: bash
+    .. code-block:: bash
 
         salt '*' status.salt_mem
         salt '*' status.salt_mem human_readable=True

salt/output/compact.py

@@ -1,7 +1,7 @@
 # -*- coding: utf-8 -*-
 '''
 Display compact output data structure
-=================================
+=====================================
 
 
 Example output::

salt/returners/mongo_future_return.py

@@ -9,7 +9,7 @@
 configure the settings for your MongoDB server, add the following lines
 to the minion config files:
 
-.. cod-block:: yaml
+.. code-block:: yaml
 
     mongo.db: <database name>
     mongo.host: <server ip address>
@@ -20,6 +20,8 @@
 You can also ask for indexes creation on the most common used fields, which
 should greatly improve performance. Indexes are not created by default.
 
+.. code-block:: yaml
+
     mongo.indexes: true
 
 Alternative configuration values can be used by prefacing the configuration.

salt/roster/clustershell.py

@@ -1,13 +1,17 @@
 # -*- coding: utf-8 -*-
 '''
 :requires: clustershell
+
 https://github.com/cea-hpc/clustershell
 
 This roster resolves hostname in a pdsh/clustershell style.
 
 When you want to use host globs for target matching, use --roster clustershell.
 
 Example:
+
+.. code-block:: bash
+
     salt-ssh --roster clustershell 'server_[1-10,21-30],test_server[5,7,9]' test.ping
 '''
 

salt/runners/http.py

@@ -19,7 +19,7 @@ def query(url, output=True, **kwargs):
     '''
     Query a resource, and decode the return data
 
-    .. versionaddedd:: 2015.2
+    .. versionadded:: 2015.2
 
     CLI Example:
 
@@ -44,7 +44,7 @@ def update_ca_bundle(target=None, source=None, merge_files=None):
     '''
     Update the local CA bundle file from a URL
 
-    .. versionaddedd:: 2015.2
+    .. versionadded:: 2015.2
 
     CLI Example:
 

salt/runners/manage.py

@@ -420,7 +420,7 @@ def reaped(subset=None, show_ipv4=False):
     show_ipv4 : False
         Also show the IP address each minion is connecting from.
 
-    .. verionadded:: Beryllium
+    .. versionadded:: Beryllium
 
     CLI Example:
 

salt/sdb/sqlite3.py

@@ -26,7 +26,7 @@
 do not exist.
 
 Advanced Usage:
-==============
+===============
 
 Instead of a table name, it is possible to provide custom SQL statements to
 create the table(s) and get and set values.

salt/states/boto_asg.py

@@ -13,12 +13,16 @@
 This module accepts explicit autoscale credentials but can also utilize
 IAM roles assigned to the instance trough Instance Profiles. Dynamic
 credentials are then automatically obtained from AWS API and no further
-configuration is necessary. More Information available at::
+configuration is necessary. More Information available at:
 
-   http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/iam-roles-for-amazon-ec2.html
+.. code-block:: text
+
+    http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/iam-roles-for-amazon-ec2.html
 
 If IAM roles are not used you need to specify them either in a pillar or
-in the minion's config file::
+in the minion's config file:
+
+.. code-block:: yaml
 
     asg.keyid: GKTADJGHEIQSXMKKRBJ08H
     asg.key: askdjghsdfjkghWupUjasdflkdfklgjsdfjajkghs

salt/states/boto_dynamodb.py

@@ -1,7 +1,7 @@
 # -*- coding: utf-8 -*-
 '''
 Manage DynamoDB Tables
-=================
+======================
 
 .. versionadded:: 2015.5.0
 

salt/states/boto_ec2.py

@@ -3,6 +3,7 @@
 Manage EC2
 
 .. versionadded:: Beryllium
+
 This module provides an interface to the Elastic Compute Cloud (EC2) service
 from AWS.
 

salt/states/pkg.py

@@ -33,6 +33,7 @@
 state module
 
 .. code-block:: yaml
+
     dotdeb.repo:
       pkgrepo.managed:
         - humanname: Dotdeb

salt/states/test.py

@@ -1,7 +1,7 @@
 # -*- coding: utf-8 -*-
 '''
 Test States
-==================
+===========
 
 Provide test case states that enable easy testing of things to do with
  state calls, e.g. running, calling, logging, output filtering etc.
@@ -351,20 +351,22 @@ def check_pillar(name,
     Checks the presence and, optionally, the type of
     given keys in Pillar.
     Supported kwargs for types are:
-        - boolean (bool)
-        - integer (int)
-        - string (str)
-        - listing (list)
-        - dictionary (dict)
+    - boolean (bool)
+    - integer (int)
+    - string (str)
+    - listing (list)
+    - dictionary (dict)
 
     Checking for None type pillars is not implemented yet.
 
-    is-pillar-foo-present-and-bar-is-int:
-      test.check_pillar:
-        - present:
-            - foo
-        - integer:
-            - bar
+    .. code-block:: yaml
+
+        is-pillar-foo-present-and-bar-is-int:
+          test.check_pillar:
+            - present:
+                - foo
+            - integer:
+                - bar
     '''
     if not (present or boolean or integer or string or
             listing or dictionary):