diff options
| author | Joshua Harlow <harlowja@gmail.com> | 2015-04-07 09:20:55 -0700 |
|---|---|---|
| committer | Joshua Harlow <harlowja@yahoo-inc.com> | 2015-04-07 18:21:42 -0700 |
| commit | c75016787aa0af15cddd6d8b02fcf009fcce67f9 (patch) | |
| tree | aa61ce6b97f9e4c1bbeb56f93e37fe7461b4ab21 | |
| parent | 9c9da4b20cef0474699d88b628c923516d91d9d6 (diff) | |
| download | oslo-log-c75016787aa0af15cddd6d8b02fcf009fcce67f9.tar.gz | |
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
| -rw-r--r-- | README.rst | 15 | ||||
| -rw-r--r-- | doc/source/api/index.rst | 9 | ||||
| -rw-r--r-- | doc/source/index.rst | 31 |
3 files changed, 34 insertions, 21 deletions
@@ -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 diff --git a/doc/source/api/index.rst b/doc/source/api/index.rst deleted file mode 100644 index a02cdb7..0000000 --- a/doc/source/api/index.rst +++ /dev/null @@ -1,9 +0,0 @@ -=============== - API Reference -=============== - -.. toctree:: - :maxdepth: 1 - :glob: - - * diff --git a/doc/source/index.rst b/doc/source/index.rst index 2edf365..ccaed93 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -1,24 +1,37 @@ -========== - oslo.log -========== +==================================== +Welcome to oslo.log's documentation! +==================================== -OpenStack logging configuration library - -Contents -======== +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). .. toctree:: - :maxdepth: 2 + :maxdepth: 1 installation - api/index usage contributing history +API Documentation +================= + +.. toctree:: + :maxdepth: 2 + + api/fixtures + api/formatters + api/handlers + api/helpers + api/log + Indices and tables ================== * :ref:`genindex` * :ref:`modindex` * :ref:`search` + +.. _oslo: https://wiki.openstack.org/wiki/Oslo |