add auto-generated docs for config options
Add automatically generated documentation for the configuration options using oslo_config.sphinxext. Change-Id: Ie698129e855dd35b2d0a4a1be625c2137f15f5e7
This commit is contained in:
parent
fcc62d9318
commit
5c9d0d4511
|
@ -22,8 +22,8 @@ sys.path.insert(0, os.path.abspath('../..'))
|
|||
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
|
||||
extensions = [
|
||||
'sphinx.ext.autodoc',
|
||||
#'sphinx.ext.intersphinx',
|
||||
'oslosphinx'
|
||||
'oslosphinx',
|
||||
'oslo_config.sphinxext',
|
||||
]
|
||||
|
||||
# autodoc generation is a bit aggressive and a nuisance when doing heavy
|
||||
|
|
|
@ -9,6 +9,7 @@ Library for running OpenStack services
|
|||
|
||||
installation
|
||||
usage
|
||||
opts
|
||||
contributing
|
||||
history
|
||||
|
||||
|
|
|
@ -0,0 +1,36 @@
|
|||
=======================
|
||||
Configuration Options
|
||||
=======================
|
||||
|
||||
oslo.service uses oslo.config to define and manage configuration options
|
||||
to allow the deployer to control how an application uses this library.
|
||||
|
||||
periodic_task
|
||||
=============
|
||||
|
||||
These options apply to services using the periodic task features of
|
||||
oslo.service.
|
||||
|
||||
.. show-options:: oslo.service.periodic_task
|
||||
|
||||
service
|
||||
=======
|
||||
|
||||
These options apply to services using the basic service framework.
|
||||
|
||||
.. show-options:: oslo.service.service
|
||||
|
||||
sslutils
|
||||
========
|
||||
|
||||
These options apply to services using the SSL utilities module.
|
||||
|
||||
.. show-options:: oslo.service.sslutils
|
||||
|
||||
wsgi
|
||||
====
|
||||
|
||||
These options apply to services using the WSGI (Web Service Gateway
|
||||
Interface) module.
|
||||
|
||||
.. show-options:: oslo.service.wsgi
|
Loading…
Reference in New Issue