Updated documentation to use readthedocs

Author: Dan

README.rst

@@ -17,10 +17,13 @@ This is a *requirement* for commands on many (hundreds/thousands/hundreds of tho
 .. image:: https://pypip.in/download/parallel-ssh/badge.png
   :target: https://pypip.in/download/parallel-ssh
   :alt: downloads
+.. image:: https://readthedocs.org/projects/parallel-ssh/badge/?version=latest
+  :target: http://parallel-ssh.readthedocs.org/en/latest/
+  :alt: Latest documentation
 
-Module documentation can be found at the repository's `github pages`_.
+Module documentation can be found at `read the docs`_.
 
-.. _`github pages`: http://pkittenis.github.io/parallel-ssh
+.. _`read the docs`: http://parallel-ssh.readthedocs.org/en/latest/
 
 ************
 Installation
@@ -34,7 +37,7 @@ Installation
 Usage Examples
 **************
 
-See documentation on `github pages`_ for more complete examples
+See documentation on `read the docs`_ for more complete examples
 
 Run `ls` on two remote hosts in parallel.
 

doc/index.rst

@@ -8,6 +8,7 @@ Welcome to Parallel-SSH's documentation!
 
 .. toctree::
    :maxdepth: 4
+   :hidden:
 
 .. automodule:: pssh
     :members: ParallelSSHClient, SSHClient, UnknownHostException, ConnectionErrorException, AuthenticationException, ProxyCommandException
@@ -17,7 +18,4 @@ Welcome to Parallel-SSH's documentation!
 Indices and tables
 ==================
 
-* :ref:`genindex`
 * :ref:`modindex`
-* :ref:`search`
-

pssh_local.py

@@ -0,0 +1,32 @@
+from pssh import SSHClient, ParallelSSHClient
+import logging
+
+logger = logging.getLogger(__name__)
+
+def _setup_logger(_logger):
+    """Setup default logger"""
+    _handler = logging.StreamHandler()
+    log_format = logging.Formatter('%(name)s - %(asctime)s - %(levelname)s - %(message)s')
+    _handler.setFormatter(log_format)
+    _logger.addHandler(_handler)
+    _logger.setLevel(logging.DEBUG)
+    
+def test():
+    client = SSHClient('localhost')
+    channel, host, stdout, stderr = client.exec_command('ls -ltrh')
+    for line in stdout:
+        print line.strip()
+    client.copy_file('../test', 'test_dir/test')
+
+def test_parallel():
+    client = ParallelSSHClient(['localhost'])
+    cmds = client.exec_command('ls -ltrh')
+    output = [client.get_stdout(cmd, return_buffers=True) for cmd in cmds]
+    print output
+    cmds = client.copy_file('../test', 'test_dir/test')
+    client.pool.join()
+
+if __name__ == "__main__":
+    _setup_logger(logger)
+    test()
+    test_parallel()