From 9102073850b8ed12ae31565d8570a48c4921f78b Mon Sep 17 00:00:00 2001 From: Doug Hellmann Date: Thu, 24 Sep 2015 18:47:45 +0000 Subject: [PATCH] Expand README and clean up intro to sphinx docs Expand the description of the library in the README and the introduction in the sphinx documentation. Change-Id: Iab72b27f37e589eaaf354b93271d366285b97f71 --- README.rst | 12 ++++++++---- doc/source/index.rst | 12 ++++++++---- 2 files changed, 16 insertions(+), 8 deletions(-) diff --git a/README.rst b/README.rst index 49e7f216..ca2abf89 100644 --- a/README.rst +++ b/README.rst @@ -1,6 +1,6 @@ -=================================== -oslo.service -=================================== +======================================================== + oslo.service -- Library for running OpenStack services +======================================================== .. image:: https://img.shields.io/pypi/v/oslo.service.svg :target: https://pypi.python.org/pypi/oslo.service/ @@ -10,7 +10,11 @@ oslo.service :target: https://pypi.python.org/pypi/oslo.service/ :alt: Downloads -Library for running OpenStack services +oslo.service provides a framework for defining new long-running +services using the patterns established by other OpenStack +applications. It also includes utilities long-running applications +might need for working with SSL or WSGI, performing periodic +operations, interacting with systemd, etc. * Free software: Apache license * Documentation: http://docs.openstack.org/developer/oslo.service diff --git a/doc/source/index.rst b/doc/source/index.rst index acce54c4..677311b1 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -1,8 +1,12 @@ -======================================== -Welcome to oslo.service's documentation! -======================================== +======================================================== + oslo.service -- Library for running OpenStack services +======================================================== -Library for running OpenStack services +oslo.service provides a framework for defining new long-running +services using the patterns established by other OpenStack +applications. It also includes utilities long-running applications +might need for working with SSL or WSGI, performing periodic +operations, interacting with systemd, etc. .. toctree:: :maxdepth: 2