rearrange content to fit the new standard layout

Change-Id: Ic218b63c96d43c3c08744f18e0e0d56dd381987c Depends-On: Ia750cb049c0f53a234ea70ce1f2bbbb7a2aa9454 Signed-off-by: Doug Hellmann <doug@doughellmann.com>
2017-06-23 12:51:30 -04:00 · 2017-06-23 12:51:30 -04:00 · 0fd6b61d4f
commit 0fd6b61d4f
parent 33d76a5d29
29 changed files with 43 additions and 23 deletions
--- a/doc/source/admin/advanced_config.rst
+++ b/doc/source/admin/advanced_config.rst
@ -2,7 +2,7 @@
 Advanced Configuration Files
 ==============================

-The oslo.config options described in :doc:`/opts` make it easy to
+The oslo.config options described in :ref:`opts` make it easy to
 enable some default logging configuration behavior such as setting the
 default log level and output file. For more advanced configurations
 using translations or multiple output destinations oslo.log relies on
--- a/doc/source/configfiles/example_nova.rst
+++ b/doc/source/configfiles/example_nova.rst
--- a/doc/source/admin/index.rst
+++ b/doc/source/admin/index.rst
@ -0,0 +1,9 @@
+==============================================
+ Administering Applications that use oslo.log
+==============================================
+
+.. toctree::
+   :maxdepth: 2
+
+   advanced_config
+   journal
--- a/doc/source/admin/journal.rst
+++ b/doc/source/admin/journal.rst
--- a/doc/source/configfiles/nova_sample.conf
+++ b/doc/source/configfiles/nova_sample.conf
--- a/doc/source/configuration/index.rst
+++ b/doc/source/configuration/index.rst
@ -1,3 +1,5 @@
+.. _opts:
+
 =======================
 Configuration Options
 =======================
--- 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
@ -10,24 +10,12 @@ logging (like resource id's etc).
 .. toctree::
   :maxdepth: 1

-   installation
-   usage
-   journal
-   migration
-   opts
-   configfiles/index
-   examples
-   contributing
-   history
-
-API Documentation
-=================
-
-.. toctree::
-   :maxdepth: 2
-   :glob:
-
-   api/*
+   install/index
+   user/index
+   reference/index
+   configuration/index
+   admin/index
+   contributor/index

 Indices and tables
 ==================
--- a/doc/source/install/index.rst
+++ b/doc/source/install/index.rst
--- a/doc/source/reference/fixtures.rst
+++ b/doc/source/reference/fixtures.rst
--- a/doc/source/reference/formatters.rst
+++ b/doc/source/reference/formatters.rst
--- a/doc/source/reference/handlers.rst
+++ b/doc/source/reference/handlers.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,8 @@
+========================
+ oslo.log API Reference
+========================
+
+.. toctree::
+   :glob:
+
+   *
--- a/doc/source/reference/log.rst
+++ b/doc/source/reference/log.rst
@ -9,4 +9,4 @@

 .. seealso::

-   :doc:`../usage`
+   :ref:`using`
--- a/doc/source/reference/versionutils.rst
+++ b/doc/source/reference/versionutils.rst
--- a/doc/source/reference/watchers.rst
+++ b/doc/source/reference/watchers.rst
@ -9,4 +9,4 @@

 .. seealso::

-   :doc:`../usage`
+   :ref:`using`
--- a/doc/source/user/examples.rst
+++ b/doc/source/user/examples.rst
--- a/doc/source/user/examples/_i18n.py
+++ b/doc/source/user/examples/_i18n.py
--- a/doc/source/user/examples/oslo_logging.py
+++ b/doc/source/user/examples/oslo_logging.py
--- a/doc/source/user/examples/python_logging.py
+++ b/doc/source/user/examples/python_logging.py
--- a/doc/source/user/examples/usage.py
+++ b/doc/source/user/examples/usage.py
--- a/doc/source/user/examples/usage_context.py
+++ b/doc/source/user/examples/usage_context.py
--- a/doc/source/user/examples/usage_helper.py
+++ b/doc/source/user/examples/usage_helper.py
--- a/doc/source/user/examples/usage_i18n.py
+++ b/doc/source/user/examples/usage_i18n.py
--- a/doc/source/user/history.rst
+++ b/doc/source/user/history.rst
@ -4,4 +4,4 @@

 .. _assert: https://docs.python.org/2/library/unittest.html#unittest.TestCase.assertTrue

-.. include:: ../../ChangeLog
+.. include:: ../../../ChangeLog
--- a/doc/source/user/index.rst
+++ b/doc/source/user/index.rst
@ -0,0 +1,13 @@
+.. _using:
+
+================
+ Using oslo.log
+================
+
+.. toctree::
+   :maxdepth: 2
+
+   usage
+   examples
+   migration
+   history
--- a/doc/source/user/migration.rst
+++ b/doc/source/user/migration.rst
--- a/doc/source/user/usage.rst
+++ b/doc/source/user/usage.rst