Merge "rearrange docs based on new standard layout"

2017-06-28 08:40:05 +00:00 · 2017-06-28 08:40:05 +00:00 · 4848dfece9
parent a8482a323b c9dd8f3a4b
commit 4848dfece9
21 changed files with 43 additions and 22 deletions
--- a/doc/source/cli/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``
--- a/doc/source/cli/index.rst
+++ b/doc/source/cli/index.rst
@ -0,0 +1,9 @@
 ================================
 oslo.config Command Line Tools
 ================================
 .. toctree::
   :maxdepth: 2
   generator
--- a/doc/source/contributor/index.rst
+++ b/doc/source/contributor/index.rst
@ -2,4 +2,4 @@
 Contributing
 ==============
-.. include:: ../../CONTRIBUTING.rst
+.. include:: ../../../CONTRIBUTING.rst
--- 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
+   reference/index
-   opts
+   cli/index
-   types
+   contributor/index
   configopts
   cfgfilter
   helpers
   fixture
   parser
   exceptions
   namespaces
   styleguide
   mutable
   generator
   builtins
   sphinxext
   sphinxconfiggen
   faq
   contributing
 Indices and tables
 ==================
--- a/doc/source/reference/builtins.rst
+++ b/doc/source/reference/builtins.rst
--- a/doc/source/reference/cfg.rst
+++ b/doc/source/reference/cfg.rst
--- a/doc/source/reference/cfgfilter.rst
+++ b/doc/source/reference/cfgfilter.rst
--- a/doc/source/reference/configopts.rst
+++ b/doc/source/reference/configopts.rst
--- a/doc/source/reference/exceptions.rst
+++ b/doc/source/reference/exceptions.rst
--- a/doc/source/reference/faq.rst
+++ b/doc/source/reference/faq.rst
--- a/doc/source/reference/fixture.rst
+++ b/doc/source/reference/fixture.rst
--- a/doc/source/reference/helpers.rst
+++ b/doc/source/reference/helpers.rst
--- a/doc/source/reference/index.rst
+++ 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
--- a/doc/source/reference/mutable.rst
+++ b/doc/source/reference/mutable.rst
--- a/doc/source/reference/namespaces.rst
+++ b/doc/source/reference/namespaces.rst
--- a/doc/source/reference/opts.rst
+++ b/doc/source/reference/opts.rst
@ -1,3 +1,5 @@
 .. _option-definitions:
 ------------------
 Option Definitions
 ------------------
--- a/doc/source/reference/parser.rst
+++ b/doc/source/reference/parser.rst
--- a/doc/source/reference/sphinxconfiggen.rst
+++ b/doc/source/reference/sphinxconfiggen.rst
--- a/doc/source/reference/sphinxext.rst
+++ b/doc/source/reference/sphinxext.rst
--- a/doc/source/reference/styleguide.rst
+++ b/doc/source/reference/styleguide.rst
--- a/doc/source/reference/types.rst
+++ b/doc/source/reference/types.rst