Add documentation for config options
This adds a doc page for oslo.limit config options by auto-generating them. Change-Id: I49070fdbf2172f87bafd4d2bd08af282c9ef29a4
This commit is contained in:
parent
ce5aa7dcca
commit
9f7a66a273
@ -21,7 +21,8 @@
|
||||
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
|
||||
extensions = [
|
||||
'openstackdocstheme',
|
||||
'sphinxcontrib.apidoc'
|
||||
'sphinxcontrib.apidoc',
|
||||
'oslo_config.sphinxext',
|
||||
]
|
||||
|
||||
apidoc_module_dir = '../../oslo_limit'
|
||||
|
@ -1,7 +1,16 @@
|
||||
========================
|
||||
oslo.limit API Reference
|
||||
========================
|
||||
=========
|
||||
Reference
|
||||
=========
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
opts
|
||||
|
||||
API
|
||||
===
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
||||
api/modules
|
||||
|
9
doc/source/reference/opts.rst
Normal file
9
doc/source/reference/opts.rst
Normal file
@ -0,0 +1,9 @@
|
||||
=====================
|
||||
Configuration Options
|
||||
=====================
|
||||
|
||||
oslo.limit uses oslo.config to define and manage configuration
|
||||
options to allow the deployer to control how an application uses the
|
||||
underlying quota limits and enforcement.
|
||||
|
||||
.. show-options:: oslo.limit
|
Loading…
x
Reference in New Issue
Block a user