Merge "Add documentation for config options"
This commit is contained in:
commit
562ada0e2d
@ -21,7 +21,8 @@
|
|||||||
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
|
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
|
||||||
extensions = [
|
extensions = [
|
||||||
'openstackdocstheme',
|
'openstackdocstheme',
|
||||||
'sphinxcontrib.apidoc'
|
'sphinxcontrib.apidoc',
|
||||||
|
'oslo_config.sphinxext',
|
||||||
]
|
]
|
||||||
|
|
||||||
apidoc_module_dir = '../../oslo_limit'
|
apidoc_module_dir = '../../oslo_limit'
|
||||||
|
@ -1,7 +1,16 @@
|
|||||||
========================
|
=========
|
||||||
oslo.limit API Reference
|
Reference
|
||||||
========================
|
=========
|
||||||
|
|
||||||
.. toctree::
|
.. toctree::
|
||||||
|
:maxdepth: 2
|
||||||
|
|
||||||
|
opts
|
||||||
|
|
||||||
|
API
|
||||||
|
===
|
||||||
|
|
||||||
|
.. toctree::
|
||||||
|
:maxdepth: 1
|
||||||
|
|
||||||
api/modules
|
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…
Reference in New Issue
Block a user