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
This commit is contained in:
		
							
								
								
									
										10
									
								
								README.rst
									
									
									
									
									
								
							
							
						
						
									
										10
									
								
								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
 | 
			
		||||
 
 | 
			
		||||
@@ -1,9 +0,0 @@
 | 
			
		||||
=====
 | 
			
		||||
 API
 | 
			
		||||
=====
 | 
			
		||||
 | 
			
		||||
.. toctree::
 | 
			
		||||
   :maxdepth: 2
 | 
			
		||||
   :glob:
 | 
			
		||||
 | 
			
		||||
   *
 | 
			
		||||
@@ -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
 | 
			
		||||
 
 | 
			
		||||
@@ -1 +0,0 @@
 | 
			
		||||
.. include:: ../../README.rst
 | 
			
		||||
		Reference in New Issue
	
	Block a user