From d04cf66a06789fc6f7c76aabcdcc3bb5f35916fa Mon Sep 17 00:00:00 2001 From: Joshua Harlow Date: Tue, 7 Apr 2015 09:16:21 -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: I7b048bc4425197f87436281dd5e46619390c3f43 --- README.rst | 10 +++++++++- doc/source/index.rst | 16 ++++++++-------- doc/source/readme.rst | 1 - 3 files changed, 17 insertions(+), 10 deletions(-) delete mode 100644 doc/source/readme.rst diff --git a/README.rst b/README.rst index 59a82ab..88cf969 100644 --- a/README.rst +++ b/README.rst @@ -2,7 +2,15 @@ oslo.concurrency ================== -Oslo concurrency library has utilities for safely running multi-thread, +.. image:: https://pypip.in/version/oslo.concurrency/badge.svg + :target: https://pypi.python.org/pypi/oslo.concurrency/ + :alt: Latest Version + +.. image:: https://pypip.in/download/oslo.concurrency/badge.svg?period=month + :target: https://pypi.python.org/pypi/oslo.concurrency/ + :alt: Downloads + +The oslo.concurrency library has utilities for safely running multi-thread, multi-process applications using locking mechanisms and for running external processes. diff --git a/doc/source/index.rst b/doc/source/index.rst index 8d1757f..9619d10 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -1,16 +1,14 @@ -.. oslo.concurrency documentation master file, created by - sphinx-quickstart on Tue Jul 9 22:26:36 2013. - You can adapt this file completely to your liking, but it should at least - contain the root `toctree` directive. +============================================ +Welcome to oslo.concurrency's documentation! +============================================ -================== - oslo.concurrency -================== +The `oslo`_ concurrency library has utilities for safely running multi-thread, +multi-process applications using locking mechanisms and for running +external processes. .. toctree:: :maxdepth: 1 - readme installation usage contributing @@ -30,3 +28,5 @@ 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