diff options
| author | Davanum Srinivas <davanum@gmail.com> | 2015-09-25 06:48:51 -0400 |
|---|---|---|
| committer | Davanum Srinivas <davanum@gmail.com> | 2015-09-25 06:48:55 -0400 |
| commit | 2f5038b712af84aa938b99c2c0050cef9d9a5ead (patch) | |
| tree | dc0b0224263f20a5300170f5335c8b1e08ca9daf /doc | |
| parent | 288fefb65118e5c701ff40adaa896ff36d03f4d3 (diff) | |
| download | oslo-policy-2f5038b712af84aa938b99c2c0050cef9d9a5ead.tar.gz | |
add auto-generated docs for config options
Add automatically generated documentation for the configuration options
using oslo_config.sphinxext.
Change-Id: I18faeb6c32dec69d3ecb4986317cada2af3632f8
Diffstat (limited to 'doc')
| -rwxr-xr-x | doc/source/conf.py | 3 | ||||
| -rw-r--r-- | doc/source/index.rst | 1 | ||||
| -rw-r--r-- | doc/source/opts.rst | 9 |
3 files changed, 12 insertions, 1 deletions
diff --git a/doc/source/conf.py b/doc/source/conf.py index caec96c..5eabf27 100755 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -23,7 +23,8 @@ sys.path.insert(0, os.path.abspath('../..')) extensions = [ 'sphinx.ext.autodoc', #'sphinx.ext.intersphinx', - 'oslosphinx' + 'oslosphinx', + 'oslo_config.sphinxext', ] # autodoc generation is a bit aggressive and a nuisance when doing heavy diff --git a/doc/source/index.rst b/doc/source/index.rst index 9fb010c..17f457f 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -11,6 +11,7 @@ Contents installation api/modules usage + opts contributing history diff --git a/doc/source/opts.rst b/doc/source/opts.rst new file mode 100644 index 0000000..cf29f0b --- /dev/null +++ b/doc/source/opts.rst @@ -0,0 +1,9 @@ +======================= + Configuration Options +======================= + +oslo.policy uses oslo.config to define and manage configuration options +to allow the deployer to control where the policy files are located and +the default rule to apply when policy etc. + +.. show-options:: oslo.policy |