rearrange existing documentation to fit the new standard layout

Change-Id: I920d02fd4843c21f41c57f0effed31441ec5998e
This commit is contained in:
Akihiro Motoki 2017-07-01 19:43:28 +09:00
parent 343ce056ea
commit 21de4a7c51
18 changed files with 60 additions and 58 deletions

View File

@ -1,16 +1,13 @@
If you would like to contribute to the development of OpenStack, If you would like to contribute to the development of OpenStack,
you must follow the steps in this page: you must follow the steps in this page:
http://docs.openstack.org/infra/manual/developers.html
http://docs.openstack.org/infra/manual/developers.html
Once those steps have been completed, changes to OpenStack Once those steps have been completed, changes to OpenStack
should be submitted for review via the Gerrit tool, following should be submitted for review via the Gerrit tool, following
the workflow documented at: the workflow documented at:
http://docs.openstack.org/infra/manual/developers.html#development-workflow
http://docs.openstack.org/infra/manual/developers.html#development-workflow
Pull requests submitted through GitHub will be ignored. Pull requests submitted through GitHub will be ignored.
Bugs should be filed on Launchpad, not GitHub: Bugs should be filed on Launchpad, not GitHub:
https://bugs.launchpad.net/oslo.service
https://bugs.launchpad.net/oslo.service

View File

@ -1,5 +0,0 @@
==============
Contributing
==============
.. include:: ../../CONTRIBUTING.rst

View File

@ -0,0 +1,5 @@
============
Contributing
============
.. include:: ../../../CONTRIBUTING.rst

View File

@ -1 +0,0 @@
.. include:: ../../ChangeLog

View File

@ -1,6 +1,6 @@
======================================================== ======================================================
oslo.service -- Library for running OpenStack services oslo.service -- Library for running OpenStack services
======================================================== ======================================================
oslo.service provides a framework for defining new long-running oslo.service provides a framework for defining new long-running
services using the patterns established by other OpenStack services using the patterns established by other OpenStack
@ -11,38 +11,14 @@ operations, interacting with systemd, etc.
.. toctree:: .. toctree::
:maxdepth: 2 :maxdepth: 2
installation install/index
usage user/index
opts configuration/index
contributing reference/index
contributor/index
API Documentation .. rubric:: Indices and tables
=================
.. toctree::
:maxdepth: 2
api/eventlet_backdoor
api/loopingcall
api/periodic_task
api/service
api/sslutils
api/systemd
api/threadgroup
Release Notes
=============
.. toctree::
:maxdepth: 1
history
Indices and tables
==================
* :ref:`genindex` * :ref:`genindex`
* :ref:`modindex` * :ref:`modindex`
* :ref:`search` * :ref:`search`
.. _oslo: https://wiki.openstack.org/wiki/Oslo

View File

@ -4,4 +4,5 @@
.. automodule:: oslo_service.eventlet_backdoor .. automodule:: oslo_service.eventlet_backdoor
:members: :members:
:undoc-members:
:show-inheritance: :show-inheritance:

View File

@ -0,0 +1,14 @@
=============
API Reference
=============
.. toctree::
:maxdepth: 1
eventlet_backdoor
loopingcall
periodic_task
service
sslutils
systemd
threadgroup

View File

@ -0,0 +1 @@
.. include:: ../../../ChangeLog

14
doc/source/user/index.rst Normal file
View File

@ -0,0 +1,14 @@
==================
Using oslo.service
==================
.. toctree::
:maxdepth: 2
usage
.. history contains a lot of sections, toctree with maxdepth 1 is used.
.. toctree::
:maxdepth: 1
history

View File

@ -1,6 +1,6 @@
======= =====
Usage Usage
======= =====
To use oslo.service in a project:: To use oslo.service in a project::
@ -23,7 +23,7 @@ configuration object:
* :func:`~oslo_service.sslutils.wrap` * :func:`~oslo_service.sslutils.wrap`
When using service from oslo-incubator When using service from oslo-incubator
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
:: ::
@ -32,7 +32,7 @@ When using service from oslo-incubator
launcher = service.launch(service, workers=2) launcher = service.launch(service, workers=2)
When using oslo.service When using oslo.service
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~
:: ::
@ -43,7 +43,7 @@ When using oslo.service
launcher = service.launch(CONF, service, workers=2) launcher = service.launch(CONF, service, workers=2)
Using oslo.service with oslo-config-generator Using oslo.service with oslo-config-generator
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The ``oslo.service`` provides several entry points to generate a configuration The ``oslo.service`` provides several entry points to generate a configuration
files. files.
@ -87,15 +87,15 @@ Launchers
oslo_service.service module provides two launchers for running services: oslo_service.service module provides two launchers for running services:
* :py:class:`oslo_service.service.ServiceLauncher` - used for * :py:class:`oslo_service.service.ServiceLauncher` - used for
running one or more service in a parent process. running one or more service in a parent process.
* :py:class:`oslo_service.service.ProcessLauncher` - forks a given * :py:class:`oslo_service.service.ProcessLauncher` - forks a given
number of workers in which service(s) are then started. number of workers in which service(s) are then started.
It is possible to initialize whatever launcher is needed and then It is possible to initialize whatever launcher is needed and then
launch a service using it. launch a service using it.
:: .. code-block:: python
from oslo_config import cfg from oslo_config import cfg
from oslo_service import service from oslo_service import service
@ -114,7 +114,7 @@ automatically pick an appropriate launcher based on a number of workers that
are passed to it (ServiceLauncher in case workers=1 or None and are passed to it (ServiceLauncher in case workers=1 or None and
ProcessLauncher in other case). ProcessLauncher in other case).
:: .. code-block:: python
from oslo_config import cfg from oslo_config import cfg
from oslo_service import service from oslo_service import service
@ -154,7 +154,7 @@ spawned. Thus, SIGHUP can be used for changing config options on the go.
Below is the example of a service with a reset method that allows reloading Below is the example of a service with a reset method that allows reloading
logging options by sending a SIGHUP. logging options by sending a SIGHUP.
:: .. code-block:: python
from oslo_config import cfg from oslo_config import cfg
from oslo_log import log as logging from oslo_log import log as logging