diff options
| author | Davanum Srinivas <davanum@gmail.com> | 2015-09-24 07:49:23 -0400 |
|---|---|---|
| committer | Davanum Srinivas <davanum@gmail.com> | 2015-09-24 07:49:29 -0400 |
| commit | 6450edb58b89b992ef8a1d10622aa9807cc0e7da (patch) | |
| tree | 480338ef8f0a5d77066218143b724845d102d385 /doc/source | |
| parent | 7daffffafc8940a5097cdd33724eff1efaa33d1a (diff) | |
| download | oslo-db-6450edb58b89b992ef8a1d10622aa9807cc0e7da.tar.gz | |
Add config options to the documentation
Add the directive to include the configuration options
to the library documentation.
Change-Id: I085cf62213340e19a2fa39b909b5c0365226f059
Diffstat (limited to 'doc/source')
| -rwxr-xr-x | doc/source/conf.py | 1 | ||||
| -rw-r--r-- | doc/source/index.rst | 1 | ||||
| -rw-r--r-- | doc/source/opts.rst | 9 |
3 files changed, 11 insertions, 0 deletions
diff --git a/doc/source/conf.py b/doc/source/conf.py index aec9352..7b14fdb 100755 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -22,6 +22,7 @@ sys.path.insert(0, os.path.abspath('../..')) extensions = [ 'sphinx.ext.autodoc', #'sphinx.ext.intersphinx', + 'oslo_config.sphinxext', 'oslosphinx' ] diff --git a/doc/source/index.rst b/doc/source/index.rst index 2be70dd..8eefaab 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -9,6 +9,7 @@ to different database backends and various other helper utils. :maxdepth: 2 installation + opts usage contributing history diff --git a/doc/source/opts.rst b/doc/source/opts.rst new file mode 100644 index 0000000..aa6f145 --- /dev/null +++ b/doc/source/opts.rst @@ -0,0 +1,9 @@ +===================== +Configuration Options +===================== + +oslo.db uses oslo.config to define and manage configuration +options to allow the deployer to control how an application uses the +underlying database. + +.. show-options:: oslo.db |