From 5b4e919879ff53e301372101ebeac58085d63d54 Mon Sep 17 00:00:00 2001
From: Joshua Harlow <harlowja@gmail.com>
Date: Tue, 7 Apr 2015 09:15:06 -0700
Subject: [PATCH] Add pypi download + version badges

Also makes the docs look more like the other
oslo libraries so that the content is easily readable
across projects.

Change-Id: I2a3497bcbf72bc4a0e6fb12f7c2d508bb3a4e6bc
---
 README.rst            | 10 +++++++++-
 doc/source/api.rst    | 10 ++++++----
 doc/source/index.rst  | 33 ++++++++++++++++++++++-----------
 doc/source/readme.rst |  1 -
 4 files changed, 37 insertions(+), 17 deletions(-)
 delete mode 100644 doc/source/readme.rst

diff --git a/README.rst b/README.rst
index 1355ad9..178fb9e 100644
--- a/README.rst
+++ b/README.rst
@@ -2,7 +2,15 @@
  oslo.serialization
 ====================
 
-The Oslo Serialization library provides support for representing objects
+.. image:: https://pypip.in/version/oslo.serialization/badge.svg
+    :target: https://pypi.python.org/pypi/oslo.serialization/
+    :alt: Latest Version
+
+.. image:: https://pypip.in/download/oslo.serialization/badge.svg?period=month
+    :target: https://pypi.python.org/pypi/oslo.serialization/
+    :alt: Downloads
+
+The oslo.serialization library provides support for representing objects
 in transmittable and storable formats, such as JSON and MessagePack.
 
 * Free software: Apache license
diff --git a/doc/source/api.rst b/doc/source/api.rst
index b3596df..c722b3a 100644
--- a/doc/source/api.rst
+++ b/doc/source/api.rst
@@ -1,9 +1,11 @@
-=====
- API
-=====
-
 jsonutils
 =========
 
 .. automodule:: oslo_serialization.jsonutils
    :members:
+
+msgpackutils
+============
+
+.. automodule:: oslo_serialization.msgpackutils
+   :members:
diff --git a/doc/source/index.rst b/doc/source/index.rst
index c4d6f55..f2c2974 100644
--- a/doc/source/index.rst
+++ b/doc/source/index.rst
@@ -1,19 +1,30 @@
-====================
- oslo.serialization
-====================
+==============================================
+Welcome to oslo.serialization's documentation!
+==============================================
 
-An OpenStack library for representing objects in transmittable and
-storable formats.
-
-Contents
-========
+The `oslo`_ serialization library provides support for representing objects
+in transmittable and storable formats, such as JSON and MessagePack.
 
 .. toctree::
    :maxdepth: 1
 
-   readme
    installation
-   api
-   history
    contributing
    history
+
+API Documentation
+=================
+
+.. toctree::
+   :maxdepth: 2
+
+   api
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`
+
+.. _oslo: https://wiki.openstack.org/wiki/Oslo
diff --git a/doc/source/readme.rst b/doc/source/readme.rst
deleted file mode 100644
index a6210d3..0000000
--- a/doc/source/readme.rst
+++ /dev/null
@@ -1 +0,0 @@
-.. include:: ../../README.rst