diff options
author | Jenkins <jenkins@review.openstack.org> | 2017-06-28 08:40:05 +0000 |
---|---|---|
committer | Gerrit Code Review <review@openstack.org> | 2017-06-28 08:40:05 +0000 |
commit | 4848dfece9167cc310897d03df0263de4853572c (patch) | |
tree | 31bbe65128759a75edc544abe198cce7a912ad3c | |
parent | a8482a323b65dd5390c4ec375b3b4b50f66bb204 (diff) | |
parent | c9dd8f3a4bbbe96989e2e66a14436f6e6feeb5c1 (diff) | |
download | oslo-config-4.7.0.tar.gz |
Merge "rearrange docs based on new standard layout"4.7.0
-rw-r--r-- | doc/source/cli/generator.rst (renamed from doc/source/generator.rst) | 2 | ||||
-rw-r--r-- | doc/source/cli/index.rst | 9 | ||||
-rw-r--r-- | doc/source/contributor/index.rst (renamed from doc/source/contributing.rst) | 2 | ||||
-rw-r--r-- | doc/source/index.rst | 26 | ||||
-rw-r--r-- | doc/source/reference/builtins.rst (renamed from doc/source/builtins.rst) | 0 | ||||
-rw-r--r-- | doc/source/reference/cfg.rst (renamed from doc/source/cfg.rst) | 0 | ||||
-rw-r--r-- | doc/source/reference/cfgfilter.rst (renamed from doc/source/cfgfilter.rst) | 0 | ||||
-rw-r--r-- | doc/source/reference/configopts.rst (renamed from doc/source/configopts.rst) | 0 | ||||
-rw-r--r-- | doc/source/reference/exceptions.rst (renamed from doc/source/exceptions.rst) | 0 | ||||
-rw-r--r-- | doc/source/reference/faq.rst (renamed from doc/source/faq.rst) | 0 | ||||
-rw-r--r-- | doc/source/reference/fixture.rst (renamed from doc/source/fixture.rst) | 0 | ||||
-rw-r--r-- | doc/source/reference/helpers.rst (renamed from doc/source/helpers.rst) | 0 | ||||
-rw-r--r-- | doc/source/reference/index.rst | 24 | ||||
-rw-r--r-- | doc/source/reference/mutable.rst (renamed from doc/source/mutable.rst) | 0 | ||||
-rw-r--r-- | doc/source/reference/namespaces.rst (renamed from doc/source/namespaces.rst) | 0 | ||||
-rw-r--r-- | doc/source/reference/opts.rst (renamed from doc/source/opts.rst) | 2 | ||||
-rw-r--r-- | doc/source/reference/parser.rst (renamed from doc/source/parser.rst) | 0 | ||||
-rw-r--r-- | doc/source/reference/sphinxconfiggen.rst (renamed from doc/source/sphinxconfiggen.rst) | 0 | ||||
-rw-r--r-- | doc/source/reference/sphinxext.rst (renamed from doc/source/sphinxext.rst) | 0 | ||||
-rw-r--r-- | doc/source/reference/styleguide.rst (renamed from doc/source/styleguide.rst) | 0 | ||||
-rw-r--r-- | doc/source/reference/types.rst (renamed from doc/source/types.rst) | 0 |
21 files changed, 43 insertions, 22 deletions
diff --git a/doc/source/generator.rst b/doc/source/cli/generator.rst index a42882b..ed5c3ed 100644 --- a/doc/source/generator.rst +++ b/doc/source/cli/generator.rst @@ -289,7 +289,7 @@ where the top-level keys are: the ``OptGroup`` they are assigned to which defaults to ``DEFAULT`` if unset. For information on the various attributes of each option, refer to - :doc:`opts`. + :ref:`option-definitions`. ``deprecated_options`` diff --git a/doc/source/cli/index.rst b/doc/source/cli/index.rst new file mode 100644 index 0000000..b81f89f --- /dev/null +++ b/doc/source/cli/index.rst @@ -0,0 +1,9 @@ +================================ + oslo.config Command Line Tools +================================ + +.. toctree:: + :maxdepth: 2 + + generator + diff --git a/doc/source/contributing.rst b/doc/source/contributor/index.rst index 2ca75d1..ed5290b 100644 --- a/doc/source/contributing.rst +++ b/doc/source/contributor/index.rst @@ -2,4 +2,4 @@ Contributing ============== -.. include:: ../../CONTRIBUTING.rst +.. include:: ../../../CONTRIBUTING.rst diff --git a/doc/source/index.rst b/doc/source/index.rst index cddbd82..4fa2eb5 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -1,5 +1,6 @@ -oslo.config -=========== +============= + oslo.config +============= An OpenStack library for parsing configuration options from the command line and configuration files. @@ -10,24 +11,9 @@ Contents .. toctree:: :maxdepth: 2 - cfg - opts - types - configopts - cfgfilter - helpers - fixture - parser - exceptions - namespaces - styleguide - mutable - generator - builtins - sphinxext - sphinxconfiggen - faq - contributing + reference/index + cli/index + contributor/index Indices and tables ================== diff --git a/doc/source/builtins.rst b/doc/source/reference/builtins.rst index fc80f74..fc80f74 100644 --- a/doc/source/builtins.rst +++ b/doc/source/reference/builtins.rst diff --git a/doc/source/cfg.rst b/doc/source/reference/cfg.rst index 5e3f988..5e3f988 100644 --- a/doc/source/cfg.rst +++ b/doc/source/reference/cfg.rst diff --git a/doc/source/cfgfilter.rst b/doc/source/reference/cfgfilter.rst index c11cddd..c11cddd 100644 --- a/doc/source/cfgfilter.rst +++ b/doc/source/reference/cfgfilter.rst diff --git a/doc/source/configopts.rst b/doc/source/reference/configopts.rst index 06c9c3b..06c9c3b 100644 --- a/doc/source/configopts.rst +++ b/doc/source/reference/configopts.rst diff --git a/doc/source/exceptions.rst b/doc/source/reference/exceptions.rst index 8036b84..8036b84 100644 --- a/doc/source/exceptions.rst +++ b/doc/source/reference/exceptions.rst diff --git a/doc/source/faq.rst b/doc/source/reference/faq.rst index 2171d13..2171d13 100644 --- a/doc/source/faq.rst +++ b/doc/source/reference/faq.rst diff --git a/doc/source/fixture.rst b/doc/source/reference/fixture.rst index 47c4939..47c4939 100644 --- a/doc/source/fixture.rst +++ b/doc/source/reference/fixture.rst diff --git a/doc/source/helpers.rst b/doc/source/reference/helpers.rst index e2d5cb4..e2d5cb4 100644 --- a/doc/source/helpers.rst +++ b/doc/source/reference/helpers.rst diff --git a/doc/source/reference/index.rst b/doc/source/reference/index.rst new file mode 100644 index 0000000..23f2d3c --- /dev/null +++ b/doc/source/reference/index.rst @@ -0,0 +1,24 @@ +=================== + Using oslo.config +=================== + +.. toctree:: + :maxdepth: 2 + + cfg + opts + types + configopts + cfgfilter + helpers + fixture + parser + exceptions + namespaces + styleguide + mutable + builtins + sphinxext + sphinxconfiggen + faq + diff --git a/doc/source/mutable.rst b/doc/source/reference/mutable.rst index ba89a16..ba89a16 100644 --- a/doc/source/mutable.rst +++ b/doc/source/reference/mutable.rst diff --git a/doc/source/namespaces.rst b/doc/source/reference/namespaces.rst index 6c5f32a..6c5f32a 100644 --- a/doc/source/namespaces.rst +++ b/doc/source/reference/namespaces.rst diff --git a/doc/source/opts.rst b/doc/source/reference/opts.rst index ccdf9a3..aaf5ead 100644 --- a/doc/source/opts.rst +++ b/doc/source/reference/opts.rst @@ -1,3 +1,5 @@ +.. _option-definitions: + ------------------ Option Definitions ------------------ diff --git a/doc/source/parser.rst b/doc/source/reference/parser.rst index 64b8b38..64b8b38 100644 --- a/doc/source/parser.rst +++ b/doc/source/reference/parser.rst diff --git a/doc/source/sphinxconfiggen.rst b/doc/source/reference/sphinxconfiggen.rst index 5768d73..5768d73 100644 --- a/doc/source/sphinxconfiggen.rst +++ b/doc/source/reference/sphinxconfiggen.rst diff --git a/doc/source/sphinxext.rst b/doc/source/reference/sphinxext.rst index 5e9a1a5..5e9a1a5 100644 --- a/doc/source/sphinxext.rst +++ b/doc/source/reference/sphinxext.rst diff --git a/doc/source/styleguide.rst b/doc/source/reference/styleguide.rst index d290ce3..d290ce3 100644 --- a/doc/source/styleguide.rst +++ b/doc/source/reference/styleguide.rst diff --git a/doc/source/types.rst b/doc/source/reference/types.rst index 9f7ea13..9f7ea13 100644 --- a/doc/source/types.rst +++ b/doc/source/reference/types.rst |