Merge sa2ajj/buildbot:more-docs-fixes (PR #1174)

master/docs/developer/cls-buildsteps.rst

@@ -536,15 +536,15 @@ This class can only be used in new-style steps.
 
     .. py:method:: pathExists(path)
 
-        :param path path to test
+        :param path: path to test
         :returns: Boolean via Deferred
 
         Determine if the given path exists on the slave (in any form - file, directory, or otherwise).
         This uses the ``stat`` command.
 
     .. py:method:: glob(path)
 
-        :param path path to test
+        :param path: path to test
         :returns: list of filenames
 
         Get the list of files matching the given path pattern on the slave.
@@ -565,26 +565,26 @@ This class can only be used in new-style steps.
     This mixin manages the following step configuration parameters, the contents of which are documented in the manual.
     Naturally, all of these are renderable.
 
-    ..py:attribute:: command
-    ..py:attribute:: workdir
-    ..py:attribute:: env
-    ..py:attribute:: want_stdout
-    ..py:attribute:: want_stderr
-    ..py:attribute:: usePTY
-    ..py:attribute:: logfiles
-    ..py:attribute:: lazylogfiles
-    ..py:attribute:: timeout
-    ..py:attribute:: maxTime
-    ..py:attribute:: logEnviron
-    ..py:attribute:: interruptSignal
-    ..py:attribute:: sigtermTime
-    ..py:attribute:: initialStdin
-    ..py:attribute:: decodeRC
-
-    ..py:method:: setupShellMixin(constructorArgs, prohibitArgs=[])
-
-        :param dict constructorArgs constructor keyword arguments
-        :param list prohibitArgs list of recognized arguments to reject
+    .. py:attribute:: command
+    .. py:attribute:: workdir
+    .. py:attribute:: env
+    .. py:attribute:: want_stdout
+    .. py:attribute:: want_stderr
+    .. py:attribute:: usePTY
+    .. py:attribute:: logfiles
+    .. py:attribute:: lazylogfiles
+    .. py:attribute:: timeout
+    .. py:attribute:: maxTime
+    .. py:attribute:: logEnviron
+    .. py:attribute:: interruptSignal
+    .. py:attribute:: sigtermTime
+    .. py:attribute:: initialStdin
+    .. py:attribute:: decodeRC
+
+    .. py:method:: setupShellMixin(constructorArgs, prohibitArgs=[])
+
+        :param dict constructorArgs: constructor keyword arguments
+        :param list prohibitArgs: list of recognized arguments to reject
         :returns: keyword arguments destined for :py:class:`BuildStep`
 
         This method is intended to be called from the shell constructor, passed any keyword arguments not otherwise used by the step.
@@ -593,7 +593,7 @@ This class can only be used in new-style steps.
 
         The return value should be passed to the :py:class:`BuildStep` constructor.
 
-    ..py:method:: makeRemoteShellCommand(collectStdout=False, collectStderr=False, \**overrides)
+    .. py:method:: makeRemoteShellCommand(collectStdout=False, collectStderr=False, \**overrides)
 
         :param collectStdout: if true, the command's stdout wil be available in ``cmd.stdout`` on completion
         :param collectStderr: if true, the command's stderr wil be available in ``cmd.stderr`` on completion

master/docs/developer/results.rst

@@ -64,12 +64,12 @@ external tools, so the values are fixed.
     This simple mixin is intended to help implement classes that will use :py:meth:`computeResultAndTermination`.
     The class has, as class attributes, the result computing configuration parameters with default values:
 
-    ..py:attribute:: haltOnFailure
-    ..py:attribute:: flunkOnWarnings
-    ..py:attribute:: flunkOnFailure
-    ..py:attribute:: warnOnWarnings
-    ..py:attribute:: warnOnFailure
+    .. py:attribute:: haltOnFailure
+    .. py:attribute:: flunkOnWarnings
+    .. py:attribute:: flunkOnFailure
+    .. py:attribute:: warnOnWarnings
+    .. py:attribute:: warnOnFailure
 
     The names of these attributes are available in the following attribute:
 
-    ..py:attribute:: resultConfig
+    .. py:attribute:: resultConfig

master/docs/manual/cfg-buildsteps.rst

@@ -1010,7 +1010,7 @@ Darcs
 
 .. py:class:: buildbot.steps.source.darcs.Darcs
 
-The :bb:step`Darcs` build step performs a `Darcs <http://darcs.net/>`_
+The :bb:step:`Darcs` build step performs a `Darcs <http://darcs.net/>`_
 checkout or update. ::
 
     from buildbot.steps.source.darcs import Darcs
@@ -2006,20 +2006,20 @@ The two :bb:step:`ShellSequence` methods below tune the behavior of how the list
 
 .. py:class:: buildbot.steps.shellsequence.ShellSequence
 
-    ..py:method:: shouldRunTheCommand(oneCmd)
+    .. py:method:: shouldRunTheCommand(oneCmd)
 
-        :param oneCommand: a string or lis of strings, as rendered from a :py:class:`~buildbot.steps.shellsequence.ShellArg` instance's ``command`` argument.
+        :param oneCmd: a string or a list of strings, as rendered from a :py:class:`~buildbot.steps.shellsequence.ShellArg` instance's ``command`` argument.
 
         Determine whether the command ``oneCmd`` should be executed.
-        If ``shouldRunTheCommand`` returns False, the result of the command will be recorded as SKIPPED.
+        If ``shouldRunTheCommand`` returns ``False``, the result of the command will be recorded as SKIPPED.
         The default methods skips all empty strings and empty lists.
 
-    ..py:method:: getFinalState()
+    .. py:method:: getFinalState()
 
         Return the status text of the step in the end.
         The default value is to set the text describing the execution of the last shell command.
 
-    ..py:method:: runShellSequence(commands):
+    .. py:method:: runShellSequence(commands):
 
         :param commands: list of shell args
 

master/docs/manual/customization.rst

@@ -855,7 +855,7 @@ Statistics can be generated for each step, and then summarized across all steps
 For example, a test step might set its ``warnings`` statistic to the number of warnings observed.
 The build could then sum the ``warnings`` on all steps to get a total number of warnings.
 
-Statistics are set and retrieved with the :py:meth:`~buildbot.process.buildstep.BuildStep.setStatistic` and:py:meth:`~buildbot.process.buildstep.BuildStep.getStatistic` methods.
+Statistics are set and retrieved with the :py:meth:`~buildbot.process.buildstep.BuildStep.setStatistic` and :py:meth:`~buildbot.process.buildstep.BuildStep.getStatistic` methods.
 The :py:meth:`~buildbot.process.buildstep.BuildStep.hasStatistic` method determines whether a statistic exists.
 
 The Build method :py:meth:`~buildbot.process.build.Build.getSummaryStatistic` can be used to aggregate over all steps in a Build.

master/docs/relnotes/index.rst

@@ -86,7 +86,9 @@ The old, clunky WebStatus has been removed.
 You will like the new interface!
 RIP WebStatus, you were a good friend.
 
-If you have code like this in your configuration (and you probably do!) ::
+If you have code like this in your configuration (and you probably do!)
+
+.. code-block:: python
 
     from buildbot.status import html
     c['status'].append(html.WebStatus(http_port=8010, allowForce=True)