From 198a9e7cf70604552e23b5a262f9fc261298ce83 Mon Sep 17 00:00:00 2001 From: Joshua Harlow Date: Tue, 7 Apr 2015 09:17:26 -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: Idb17dd30403daa130176643f4609fdd7c61c076e --- README.rst | 11 ++++++++++- doc/source/index.rst | 24 +++++++++++++++--------- 2 files changed, 25 insertions(+), 10 deletions(-) diff --git a/README.rst b/README.rst index fd91423b..a68dbded 100644 --- a/README.rst +++ b/README.rst @@ -2,7 +2,16 @@ oslo.db ========= -Database connection library for OpenStack +.. image:: https://pypip.in/version/oslo.db/badge.svg + :target: https://pypi.python.org/pypi/oslo.db/ + :alt: Latest Version + +.. image:: https://pypip.in/download/oslo.db/badge.svg?period=month + :target: https://pypi.python.org/pypi/oslo.db/ + :alt: Downloads + +The oslo db (database) handling library, it provides database connectivity +to different database backends and various other helper utils. * Free software: Apache license * Documentation: http://docs.openstack.org/developer/oslo.db diff --git a/doc/source/index.rst b/doc/source/index.rst index 5e967668..2be70ddf 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -1,25 +1,31 @@ -========= - oslo.db -========= +=================================== +Welcome to oslo.db's documentation! +=================================== -The Oslo database handling library. Provides database connectivity -to the different backends and helper utils. - -Contents --------- +The `oslo`_ db (database) handling library, it provides database connectivity +to different database backends and various other helper utils. .. toctree:: :maxdepth: 2 installation usage - api/index contributing history +API Documentation +================= + +.. toctree:: + :maxdepth: 2 + + api/index + Indices and tables ------------------ * :ref:`genindex` * :ref:`modindex` * :ref:`search` + +.. _oslo: https://wiki.openstack.org/wiki/Oslo