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: Ic9837b59d194331c604b2ceddc118f2b1c5093f1
This commit is contained in:
Joshua Harlow 2015-04-07 09:20:55 -07:00 committed by Joshua Harlow
parent 9c9da4b20c
commit c75016787a
3 changed files with 36 additions and 23 deletions

View File

@ -2,9 +2,18 @@
oslo.log -- Oslo Logging Library
================================
OpenStack logging configuration library provides standardized configuration for
all openstack projects. It also provides custom formatters, handlers and
support for context specific logging (like resource id's etc).
.. image:: https://pypip.in/version/oslo.log/badge.svg
:target: https://pypi.python.org/pypi/oslo.log/
:alt: Latest Version
.. image:: https://pypip.in/download/oslo.log/badge.svg?period=month
:target: https://pypi.python.org/pypi/oslo.log/
:alt: Downloads
The oslo.log (logging) configuration library provides standardized
configuration for all openstack projects. It also provides custom
formatters, handlers and support for context specific
logging (like resource id's etc).
* Free software: Apache license
* Documentation: http://docs.openstack.org/developer/oslo.log

View File

@ -1,9 +0,0 @@
===============
API Reference
===============
.. toctree::
:maxdepth: 1
:glob:
*

View File

@ -1,20 +1,31 @@
==========
oslo.log
==========
====================================
Welcome to oslo.log's documentation!
====================================
OpenStack logging configuration library
The `oslo`_ log (logging) configuration library provides standardized
configuration for all openstack projects. It also provides custom
formatters, handlers and support for context specific
logging (like resource id's etc).
Contents
========
.. toctree::
:maxdepth: 1
installation
usage
contributing
history
API Documentation
=================
.. toctree::
:maxdepth: 2
installation
api/index
usage
contributing
history
api/fixtures
api/formatters
api/handlers
api/helpers
api/log
Indices and tables
==================
@ -22,3 +33,5 @@ Indices and tables
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
.. _oslo: https://wiki.openstack.org/wiki/Oslo