From cb88d17a365fb8865c4e7cfd7a2d431b8e920cad Mon Sep 17 00:00:00 2001 From: Joshua Harlow Date: Tue, 7 Apr 2015 13:35:01 -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: I85158a89f103cdef2afa268558592c46ce6c3411 --- README.rst | 10 +++++++++- doc/source/api/index.rst | 9 --------- doc/source/index.rst | 32 +++++++++++++++++++++++++------- doc/source/readme.rst | 1 - 4 files changed, 34 insertions(+), 18 deletions(-) delete mode 100644 doc/source/api/index.rst delete mode 100644 doc/source/readme.rst diff --git a/README.rst b/README.rst index b2ec290d..9d91985a 100644 --- a/README.rst +++ b/README.rst @@ -2,7 +2,15 @@ oslo.utils ========== -The Oslo Utils library provides support for common utility type functions, +.. image:: https://pypip.in/version/oslo.utils/badge.svg + :target: https://pypi.python.org/pypi/oslo.utils/ + :alt: Latest Version + +.. image:: https://pypip.in/download/oslo.utils/badge.svg?period=month + :target: https://pypi.python.org/pypi/oslo.utils/ + :alt: Downloads + +The oslo.utils library provides support for common utility type functions, such as encoding, exception handling, string manipulation, and time handling. * Free software: Apache license diff --git a/doc/source/api/index.rst b/doc/source/api/index.rst deleted file mode 100644 index f193e3b6..00000000 --- a/doc/source/api/index.rst +++ /dev/null @@ -1,9 +0,0 @@ -===== - API -===== - -.. toctree:: - :maxdepth: 2 - :glob: - - * diff --git a/doc/source/index.rst b/doc/source/index.rst index 1dce4d7f..62980267 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -1,17 +1,33 @@ +====================================== Welcome to oslo.utils's documentation! ====================================== -Contents: +The `oslo`_ utils library provides support for common utility type functions, +such as encoding, exception handling, string manipulation, and time handling. + +.. toctree:: + :maxdepth: 1 + + installation + usage + contributing + history + +API Documentation +================= .. toctree:: :maxdepth: 2 - readme - installation - usage - api/index - contributing - history + api/encodeutils + api/eventletutils + api/excutils + api/fixture + api/importutils + api/netutils + api/strutils + api/timeutils + api/units Indices and tables ================== @@ -19,3 +35,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 a6210d3d..00000000 --- a/doc/source/readme.rst +++ /dev/null @@ -1 +0,0 @@ -.. include:: ../../README.rst