Improve the library's documentation

This commit is the first step in improving the library's documentation.
It adds missing details to a lot of the default cookiecutter docs which
have mostly sat untouched since the repo was created. The release notes
are also brought up to date and adds autodoc pages for all the modules
with public functions.

Change-Id: Id249c95fb269d07628952a4182675bce1fc18a53

README.rst

@@ -9,7 +9,19 @@ OpenStack Functional Testing Library
 * Source: http://git.openstack.org/cgit/openstack/tempest-lib
 * Bugs: http://bugs.launchpad.net/tempest
 
+tempest-lib is a library of common functionality that was originally in tempest
+(or similar in scope to tempest)
+
 Features
 --------
 
-* TODO
+Some of the current functionality exposed from the library includes:
+
+* OpenStack python-* client CLI testing framework
+* subunit-trace: A output filter for subunit streams. Useful in conjunction
+                 with calling a test runner that emits subunit
+* A unified REST Client
+* Utility functions:
+  * skip_because: Skip a test because of a bug
+  * find_test_caller: Perform stack introspection to find the test caller.
+                      common methods

doc/source/cli.rst

@@ -1,3 +1,8 @@
+.. _cli:
+
+CLI Testing Framework Usage
+===========================
+
 -------------------
 The cli.base module
 -------------------

doc/source/decorators.rst

@@ -0,0 +1,13 @@
+.. _decorators:
+
+Decorators Usage Guide
+======================
+
+---------------------
+The decorators module
+---------------------
+
+.. automodule:: tempest_lib.decorators
+   :members:
+
+

doc/source/index.rst

@@ -16,10 +16,43 @@ Contents:
    usage
    contributing
    cli
+   decorators
 
 Release Notes
 =============
 
+0.2.1
+-----
+ * Fix subunit-trace to enable stdout passthrough
+
+0.2.0
+-----
+ * Adds the skip_because decorator which was migrated from tempest
+ * Fixes to rest_client
+  * Separates the forbid
+ * Cleans up the exception classes to make inheritance simpler
+ * Doc typo fixes
+
+0.1.0
+-----
+ * Adds the RestClient class which was migrated from tempest
+ * Fix subunit-trace to handle when there isn't a worker tag in the subunit
+   stream
+
+0.0.4
+-----
+ * Fix subunit-trace when running with python < 2.7
+
+0.0.3
+-----
+ * subunit-trace bug fixes:
+  * Switch to using elapsed time for the summary view
+  * Addition of --failonly option from nova's forked subunit-trace
+
+0.0.2
+-----
+ * Fix the MRO ordering in the base test class
+
 0.0.1
 -----
  * Adds cli testing framework

doc/source/rest_client.rst

@@ -0,0 +1,11 @@
+.. _rest_client:
+
+Rest Client Usage
+=================
+
+----------------------
+The rest_client module
+----------------------
+
+.. automodule:: tempest_lib.common.rest_client
+   :members:

doc/source/usage.rst

@@ -4,4 +4,21 @@ Usage
 
 To use tempest-lib in a project::
 
-    import tempest_lib
+    import tempest_lib
+
+:ref:`cli`
+----------
+The CLI testing framework allows you to test the command line interface for
+an OpenStack project's python-*client
+
+
+:ref:`decorators`
+-----------------
+These decorators enable common utility functions inside of your test suite
+
+
+:ref:`rest_client`
+------------------
+The base building block for making a project specific client
+
+

doc/source/utils.rst

@@ -0,0 +1,11 @@
+.. _utils:
+
+Utils Usage
+===========
+
+---------------
+The misc module
+---------------
+
+.. automodule:: tempest_lib.common.utils.misc
+   :members: