Update and clean up docs

* Reference the readme.rst in index.rst to remove redundancy
* General cleanup and updates

Change-Id: I33c9c12b94282ce3a0b3366715a3797e6c3b019c

README.rst

@@ -1,10 +1,14 @@
-==============
+======
-Python Jenkins
+README
-==============
+======
 
-Python Jenkins is a python library that wraps the Jenkins REST interface.
+Python Jenkins is a python wrapper for the `Jenkins <http://jenkins-ci.org/>`_
-We like to use it to automate our Jenkins servers. Here are some of the
+REST API which aims to provide a more conventionally pythonic way of controlling
-things you can use it for:
+a Jenkins server.  It provides a higher-level API containing a number of
+convenience functions.
+
+We like to use python-jenkins to automate our Jenkins servers. Here are some of
+the things you can use it for:
 
 * Create new jobs
 * Copy existing jobs
@@ -33,9 +37,13 @@ Bug report:
 
 * https://bugs.launchpad.net/python-jenkins
 
+Repository:
+
+* https://git.openstack.org/cgit/stackforge/python-jenkins
+
 Cloning:
 
-* https://git.openstack.org/stackforge/python-jenkins
+* git clone https://git.openstack.org/stackforge/python-jenkins
 
 Patches are submitted via Gerrit at:
 

doc/source/index.rst

@@ -1,20 +1,16 @@
-Welcome to Python Jenkins's documentation!
+Python Jenkins
-==========================================
+==============
 
-Python Jenkins is a library for the remote API of the `Jenkins
+.. include:: ../../README.rst
-<http://jenkins-ci.org/>`_ continuous integration server. It is useful
-for creating and managing jobs as well as build nodes.
-
-Table of content:
 
+Contents
+========
 .. toctree::
-    :maxdepth: 2
+    :maxdepth: 3
     :glob:
 
     *
 
-Python Jenkins development is hosted on Launchpad: https://launchpad.net/python-jenkins
-
 Indices and tables
 ==================
 

doc/source/install.rst

@@ -25,3 +25,34 @@ And on Fedora 19 and later::
 For development::
 
     python setup.py develop
+
+
+Documentation
+-------------
+
+Documentation is included in the ``doc`` folder. To generate docs
+locally execute the command::
+
+    tox -e docs
+
+The generated documentation is then available under
+``doc/build/html/index.html``.
+
+Unit Tests
+----------
+
+Unit tests have been included and are in the ``tests`` folder.  We recently
+started including unit tests as examples in our documentation so to keep the
+examples up to date it is very important that we include unit tests for
+every module.  To run the unit tests, execute the command::
+
+    tox -e py27
+
+* Note: View ``tox.ini`` to run tests on other versions of Python.
+
+Test Coverage
+-------------
+
+To measure test coverage, execute the command::
+
+    tox -e cover