Merge pull request #10573 from terminalmage/docs

Fix sphinx build warnings/errors

doc/contents.rst

@@ -8,33 +8,34 @@ Salt Table of Contents
 
     faq
 
+    topics/cloud/index
+    topics/community
+    topics/configuration
+    topics/conventions/*
+    topics/development/*
+    topics/eauth/*
+    topics/event/index
+    topics/git/*
+    topics/hacking
     topics/index
     topics/installation/index
-    topics/configuration
-    topics/hacking
-    topics/targeting/index
-    topics/tutorials/index
-    topics/eauth/*
-    topics/pillar/index
-    topics/master_tops/index
     topics/jobs/*
-    topics/nonroot
-    topics/troubleshooting/*
-    topics/community
-    topics/projects/index
-    topics/event/index
+    topics/master_tops/index
     topics/mine/*
-    topics/cloud/index
-    topics/virt/*
-    topics/ssh/*
-    topics/tests/*
+    topics/nonroot
+    topics/pillar/index
+    topics/projects/index
+    topics/proxyminion/*
     topics/reactor/*
-    topics/conventions/*
-    topics/git/*
-    topics/development/index
-    topics/translating
     topics/salt_projects
-    topics/proxyminion/index
+    topics/ssh/*
+    topics/targeting/index
+    topics/tests/*
+    topics/translating
+    topics/troubleshooting/*
+    topics/tutorials/index
+    topics/virt/*
+    topics/yaml/*
 
     ref/configuration/logging/*
     ref/configuration/logging/handlers/*

doc/topics/releases/0.9.8.rst

@@ -335,7 +335,7 @@ The :doc:`virt </ref/modules/all/salt.modules.virt>` module gained basic Xen sup
 The :doc:`yum </ref/modules/all/salt.modules.yumpkg>` module gained
 Scientific Linux support.
 
-The :doc:`pkg </ref/modules/all/salt.modules.apt>` module on Debian, Ubuntu,
+The :doc:`pkg </ref/modules/all/salt.modules.aptpkg>` module on Debian, Ubuntu,
 and derivatives force apt to run in a non-interactive mode. This prevents
 issues when package installation waits for confirmation.
 

doc/topics/releases/2014.1.0.rst

@@ -218,21 +218,21 @@ currently used by salt-cloud when bootstrapping salt on clouds which require
 the use of a password.
 
 
-Proxy Minions¬
--------------¬
-¬
-Initial basic support for Proxy Minions is in this release.  Documentation can¬
-be found :doc:`here </topics/proxyminion>`.⌴⌴¬
-¬
-Proxy minions are a developing feature in Salt that enables control of¬
-devices that cannot run a minion.  Examples include network gear like switches¬
-and routers that run a proprietary OS but offer an API, or "dumb"¬
-devices that just don't have the horsepower or ability to handle a Python VM.¬
-¬
-Proxy minions can be difficult to write, so a simple REST-based example proxy¬
-is included.  A Python bottle-based webserver can be found at⌴¬
-http://github.com/cro/salt-proxy-rest as an endpoint for this proxy.¬
+Proxy Minions
+-------------
 
-This is an ALPHA-quality feature.  There are a number of issues with it
+Initial basic support for Proxy Minions is in this release. Documentation can
+be found :doc:`here </topics/proxyminion/index>`.
+
+Proxy minions are a developing feature in Salt that enables control of devices
+that cannot run a minion. Examples include network gear like switches and
+routers that run a proprietary OS but offer an API, or "dumb" devices that just
+don't have the horsepower or ability to handle a Python VM.
+
+Proxy minions can be difficult to write, so a simple REST-based example proxy
+is included. A Python bottle-based webserver can be found at
+http://github.com/cro/salt-proxy-rest as an endpoint for this proxy.
+
+This is an ALPHA-quality feature. There are a number of issues with it
 currently, mostly centering around process control, logging, and inability to
 work in a masterless configuration.

doc/topics/yaml/index.rst

@@ -25,24 +25,29 @@ Rule Two: Colons
 Python dictionaries are, of course, simply key-value pairs. Users from other
 languages may recognize this data type as hashes or associative arrays.
 
-Dictionary keys are represented in YAML as strings terminated by a trailing colon.
-Values are represented by either a string following the colon, separated by a space:
+Dictionary keys are represented in YAML as strings terminated by a trailing
+colon. Values are represented by either a string following the colon,
+separated by a space:
 
 .. code-block:: yaml
+
     my_key: my_value
 
 In Python, the above maps to:
 
 .. code-block:: python
+
     {'my_key': 'my_value'}
 
 Alternatively, a value can be associated with a key through indentation.
 
 .. code-block:: yaml
+
     my_key:
       my_value
 
 .. note::
+
     The above syntax is valid YAML but is uncommon in SLS files because most often,
     the value for a key is not singular but instead is a *list* of values.
 
@@ -52,12 +57,19 @@ In Python, the above maps to:
 Dictionaries can be nested:
 
 .. code-block:: yaml
+
     first_level_dict_key:
       second_level_dict_key: value_in_second_level_dict
 
 And in Python:
+
 .. code-block:: python
-    
+
+    {
+        'first_level_dict_key': {
+            'second_level_dict_key': 'value_in_second_level_dict'
+        }
+    }
 
 Rules Three: Dashes
 -------------------
@@ -66,6 +78,7 @@ To represent lists of items, a single dash followed by a space is used. Multiple
 items are a part of the same list as a function of their having the same level of indentation.
 
 .. code-block:: yaml
+
     - list_value_one
     - list_value_two
     - list_value_three

salt/renderers/pydsl.py

@@ -10,7 +10,7 @@ The `pydsl` renderer allows one to author salt formulas(.sls files) in pure
 Python using a DSL that's easy to write and easy to read. Here's an example:
 
 .. code-block:: python
-   :linenos:
+    :linenos:
 
     #!pydsl
 
@@ -321,6 +321,7 @@ by getting a reference from Python's `sys.modules` dictionary.
 For example:
 
 .. code-block:: python
+
     #!pydsl|stateconf -ps
 
     def main():