diff --git a/doc/source/configfiles/index.rst b/doc/source/admin/advanced_config.rst similarity index 95% rename from doc/source/configfiles/index.rst rename to doc/source/admin/advanced_config.rst index 5b1c769b..6c06e47a 100644 --- a/doc/source/configfiles/index.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 diff --git a/doc/source/configfiles/example_nova.rst b/doc/source/admin/example_nova.rst similarity index 100% rename from doc/source/configfiles/example_nova.rst rename to doc/source/admin/example_nova.rst diff --git a/doc/source/admin/index.rst b/doc/source/admin/index.rst new file mode 100644 index 00000000..b777abda --- /dev/null +++ b/doc/source/admin/index.rst @@ -0,0 +1,9 @@ +============================================== + Administering Applications that use oslo.log +============================================== + +.. toctree:: + :maxdepth: 2 + + advanced_config + journal diff --git a/doc/source/journal.rst b/doc/source/admin/journal.rst similarity index 100% rename from doc/source/journal.rst rename to doc/source/admin/journal.rst diff --git a/doc/source/configfiles/nova_sample.conf b/doc/source/admin/nova_sample.conf similarity index 100% rename from doc/source/configfiles/nova_sample.conf rename to doc/source/admin/nova_sample.conf diff --git a/doc/source/opts.rst b/doc/source/configuration/index.rst similarity index 99% rename from doc/source/opts.rst rename to doc/source/configuration/index.rst index f329f8ee..22f81434 100644 --- a/doc/source/opts.rst +++ b/doc/source/configuration/index.rst @@ -1,3 +1,5 @@ +.. _opts: + ======================= Configuration Options ======================= diff --git a/doc/source/contributing.rst b/doc/source/contributor/index.rst similarity index 50% rename from doc/source/contributing.rst rename to doc/source/contributor/index.rst index 97344d14..3d4ceb40 100644 --- a/doc/source/contributing.rst +++ b/doc/source/contributor/index.rst @@ -2,4 +2,4 @@ Contributing ============ -.. include:: ../../CONTRIBUTING.rst \ No newline at end of file +.. include:: ../../../CONTRIBUTING.rst diff --git a/doc/source/index.rst b/doc/source/index.rst index 77beebf2..9153f13b 100644 --- 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 ================== diff --git a/doc/source/installation.rst b/doc/source/install/index.rst similarity index 100% rename from doc/source/installation.rst rename to doc/source/install/index.rst diff --git a/doc/source/api/fixtures.rst b/doc/source/reference/fixtures.rst similarity index 100% rename from doc/source/api/fixtures.rst rename to doc/source/reference/fixtures.rst diff --git a/doc/source/api/formatters.rst b/doc/source/reference/formatters.rst similarity index 100% rename from doc/source/api/formatters.rst rename to doc/source/reference/formatters.rst diff --git a/doc/source/api/handlers.rst b/doc/source/reference/handlers.rst similarity index 100% rename from doc/source/api/handlers.rst rename to doc/source/reference/handlers.rst diff --git a/doc/source/api/helpers.rst b/doc/source/reference/helpers.rst similarity index 100% rename from doc/source/api/helpers.rst rename to doc/source/reference/helpers.rst diff --git a/doc/source/reference/index.rst b/doc/source/reference/index.rst new file mode 100644 index 00000000..4190cdb0 --- /dev/null +++ b/doc/source/reference/index.rst @@ -0,0 +1,8 @@ +======================== + oslo.log API Reference +======================== + +.. toctree:: + :glob: + + * diff --git a/doc/source/api/log.rst b/doc/source/reference/log.rst similarity index 88% rename from doc/source/api/log.rst rename to doc/source/reference/log.rst index b4d42bee..1d2ac89b 100644 --- a/doc/source/api/log.rst +++ b/doc/source/reference/log.rst @@ -9,4 +9,4 @@ .. seealso:: - :doc:`../usage` + :ref:`using` diff --git a/doc/source/api/versionutils.rst b/doc/source/reference/versionutils.rst similarity index 100% rename from doc/source/api/versionutils.rst rename to doc/source/reference/versionutils.rst diff --git a/doc/source/api/watchers.rst b/doc/source/reference/watchers.rst similarity index 89% rename from doc/source/api/watchers.rst rename to doc/source/reference/watchers.rst index 367d8c2e..0d6c41b5 100644 --- a/doc/source/api/watchers.rst +++ b/doc/source/reference/watchers.rst @@ -9,4 +9,4 @@ .. seealso:: - :doc:`../usage` + :ref:`using` diff --git a/doc/source/examples.rst b/doc/source/user/examples.rst similarity index 100% rename from doc/source/examples.rst rename to doc/source/user/examples.rst diff --git a/doc/source/examples/_i18n.py b/doc/source/user/examples/_i18n.py similarity index 100% rename from doc/source/examples/_i18n.py rename to doc/source/user/examples/_i18n.py diff --git a/doc/source/examples/oslo_logging.py b/doc/source/user/examples/oslo_logging.py similarity index 100% rename from doc/source/examples/oslo_logging.py rename to doc/source/user/examples/oslo_logging.py diff --git a/doc/source/examples/python_logging.py b/doc/source/user/examples/python_logging.py similarity index 100% rename from doc/source/examples/python_logging.py rename to doc/source/user/examples/python_logging.py diff --git a/doc/source/examples/usage.py b/doc/source/user/examples/usage.py similarity index 100% rename from doc/source/examples/usage.py rename to doc/source/user/examples/usage.py diff --git a/doc/source/examples/usage_context.py b/doc/source/user/examples/usage_context.py similarity index 100% rename from doc/source/examples/usage_context.py rename to doc/source/user/examples/usage_context.py diff --git a/doc/source/examples/usage_helper.py b/doc/source/user/examples/usage_helper.py similarity index 100% rename from doc/source/examples/usage_helper.py rename to doc/source/user/examples/usage_helper.py diff --git a/doc/source/examples/usage_i18n.py b/doc/source/user/examples/usage_i18n.py similarity index 100% rename from doc/source/examples/usage_i18n.py rename to doc/source/user/examples/usage_i18n.py diff --git a/doc/source/history.rst b/doc/source/user/history.rst similarity index 88% rename from doc/source/history.rst rename to doc/source/user/history.rst index 4e3ef9d7..70d5170e 100644 --- a/doc/source/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 diff --git a/doc/source/user/index.rst b/doc/source/user/index.rst new file mode 100644 index 00000000..530775ad --- /dev/null +++ b/doc/source/user/index.rst @@ -0,0 +1,13 @@ +.. _using: + +================ + Using oslo.log +================ + +.. toctree:: + :maxdepth: 2 + + usage + examples + migration + history diff --git a/doc/source/migration.rst b/doc/source/user/migration.rst similarity index 100% rename from doc/source/migration.rst rename to doc/source/user/migration.rst diff --git a/doc/source/usage.rst b/doc/source/user/usage.rst similarity index 100% rename from doc/source/usage.rst rename to doc/source/user/usage.rst