Updated sphinx min version and default theme. Added exit code to output representation. Updated docstrings

Author: Dan

doc/conf.py

@@ -25,14 +25,16 @@
 # -- General configuration ------------------------------------------------
 
 # If your documentation needs a minimal Sphinx version, state it here.
-#needs_sphinx = '1.0'
+needs_sphinx = '1.3'
 
 # Add any Sphinx extension module names here, as strings. They can be
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
 extensions = [
     'sphinx.ext.autodoc',
     'sphinx.ext.intersphinx',
+    'sphinx.ext.autosummary',
+    'sphinx.ext.coverage',
     # 'sphinx.ext.viewcode',
 ]
 
@@ -58,7 +60,7 @@
 
 # General information about the project.
 project = u'Parallel-SSH'
-copyright = u'2015-, P Kittenis'
+copyright = u'2014-2017, P Kittenis'
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the
@@ -112,7 +114,7 @@
 
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
-html_theme = 'default'
+html_theme = 'sphinx_rtd_theme'
 
 # Theme options are theme-specific and customize the look and feel of a theme
 # further.  For a list of options available for each theme, see the

pssh/agent.py

@@ -46,8 +46,9 @@ def __init__(self):
 
     def add_key(self, key):
         """Add key to agent.
+
         :param key: Key to add
-        :type key: :mod:`paramiko.pkey.PKey`
+        :type key: :py:class:`paramiko.pkey.PKey`
         """
         self.keys.append(key)
 

pssh/output.py

@@ -46,7 +46,7 @@ def __init__(self, host, cmd, channel, stdout, stderr, stdin,
         :param exit_code: Exit code of command
         :type exit_code: int or None
         :param exception: Exception from host if any
-        :type exception: Exception or None
+        :type exception: :py:class:`Exception` or ``None``
         """
         dict.__init__(self, (('host', host), ('cmd', cmd), ('channel', channel),
                              ('stdout', stdout), ('stderr', stderr),
@@ -73,8 +73,10 @@ def update(self, update_dict):
 
     def __repr__(self):
         return "{linesep}\thost={host}{linesep}" \
+"\texit_code={exit_code}{linesep}" \
 "\tcmd={cmd}{linesep}\tchannel={channel}{linesep}" \
 "\tstdout={stdout}{linesep}\tstderr={stderr}{linesep}\tstdin={stdin}{linesep}\
 \texception={exception}{linesep}".format(
     host=self.host, cmd=self.cmd, channel=self.channel, stdout=self.stdout,
-    stdin=self.stdin, stderr=self.stderr, exception=self.exception, linesep=linesep,)
+    stdin=self.stdin, stderr=self.stderr, exception=self.exception,
+    linesep=linesep, exit_code=self.exit_code)