Merge pull request #18197 from nmadhok/doc-fixes

Fixing sphinx violations and errors

doc/ref/configuration/minion.rst

@@ -726,7 +726,7 @@ directed to look on the minion by setting this parameter to ``local``.
 .. conf_minion:: use_master_when_local
 
 ``use_master_when_local``
----------------
+-------------------------
 
 Default: ``False``
 

doc/topics/development/modular_systems.rst

@@ -82,6 +82,7 @@ This provides a console that has access to all the vars and functions, and even
 supports tab-completion.
 
 .. code-block:: python
+
     print(test)
     test123
 

doc/topics/development/tests/index.rst

@@ -43,8 +43,7 @@ specific groups of tests or individual tests:
 * Run unit and integration tests for states: ``./tests/runtests.py --state``
 * Run integration tests for an individual module: ``./tests/runtests.py -n integration.modules.virt``
 * Run unit tests for an individual module: ``./tests/runtests.py -n unit.modules.virt_test``
-* Run an individual test by using the class and test name (this example is for the ``test_default_kvm_profile`` test in the
+* Run an individual test by using the class and test name (this example is for the ``test_default_kvm_profile`` test in the ``integration.module.virt``): ``./tests/runtests.py -n ingtegration.module.virt.VirtTest.test_default_kvm_profile``
-``integration.module.virt``): ``./tests/runtests.py -n ingtegration.module.virt.VirtTest.test_default_kvm_profile``
 
 
 Running Unit Tests Without Integration Test Daemons

doc/topics/event/index.rst

@@ -113,6 +113,7 @@ If a process is listening on the minion, it may be useful for a user on the
 master to fire an event to it:
 
 .. code-block:: python
+
     # Job on minion
     import salt.utils.event
 

doc/topics/releases/2014.7.0.rst

@@ -347,7 +347,7 @@ request. As an example, Amazon or GitHub requests are signed this way.
 Generating and Accepting Minion Keys
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-The :py:method:`/key <salt.netapi.rest_cherrypy.app.Keys.POST>` convenience URL
+The :py:func:`/key <salt.netapi.rest_cherrypy.app.Keys.POST>` convenience URL
 generates a public and private key for a minion, automatically pre-accepts the
 public key on the Salt Master, and returns both keys as a tarball for download.
 

doc/topics/troubleshooting/index.rst

@@ -10,18 +10,24 @@ Troubleshooting the Salt Master
 ===============================
 
 If your Salt master is having issues such as minions not returning data, slow
-execution times, or a variety of other issues the 
+execution times, or a variety of other issues, the following links contain
-:doc:`Salt master troubleshooting page
+details on troubleshooting the most common issues encountered:
-</topics/troubleshooting/master>` contains details on troubleshooting the most
+
-common issues encountered.
+.. toctree::
+    :maxdepth: 2
+
+    master
 
 Troubleshooting the Salt Minion
 ===============================
 
-In the event that your Salt minion is having issues a variety of solutions
+In the event that your Salt minion is having issues, a variety of solutions
-and suggestions are available at the :doc:`Salt minion troubleshooting page
+and suggestions are available. Please refer to the following links for more information:
-</topics/troubleshooting/minion>`.
 
+.. toctree::
+    :maxdepth: 2
+
+    minion
 
 Running in the Foreground
 =========================
@@ -209,8 +215,12 @@ needs to be run with the ``python26`` executable.
 Common YAML Gotchas
 ===================
 
-An extensive list of :doc:`YAML idiosyncrasies
+An extensive list of YAML idiosyncrasies has been compiled:
-</topics/troubleshooting/yaml_idiosyncrasies>` has been compiled.
+
+.. toctree::
+    :maxdepth: 2
+
+    yaml_idiosyncrasies
 
 Live Python Debug Output
 ========================

doc/topics/tutorials/index.rst

@@ -69,5 +69,3 @@ Using Salt at scale
     :maxdepth: 2
 
     intro_scale
-    the_master
-    the_minion

salt/modules/dockerio.py

@@ -606,11 +606,13 @@ def create_container(image,
         CPU shares (relative weight)
     cpuset
         CPUs in which to allow execution ('0-3' or '0,1')
+
     CLI Example:
 
     .. code-block:: bash
 
         salt '*' docker.create_container o/ubuntu volumes="['/s','/m:/f']"
+
     '''
     status = base_status.copy()
     client = _get_client()

salt/modules/pagerduty.py

@@ -67,9 +67,11 @@ def create_event(service_key=None, description=None, details=None,
 
     CLI Example:
 
+    .. code-block:: yaml
+
         pagerduty.create_event <service_key> <description> <details> \
-            profile=my-pagerduty-account
+        profile=my-pagerduty-account
-:
+
     The following parameters are required:
 
     service_key