diff --git a/doc/source/oslo_config.rst b/doc/source/configuration/index.rst similarity index 97% rename from doc/source/oslo_config.rst rename to doc/source/configuration/index.rst index e6134a5..6ca076e 100644 --- a/doc/source/oslo_config.rst +++ b/doc/source/configuration/index.rst @@ -53,5 +53,5 @@ This will override any configuration done via oslo.config .. note:: - healtcheck middleware does not yet use oslo.config, see :doc:`healthcheck_plugins` + healtcheck middleware does not yet use oslo.config, see :doc:`../reference/healthcheck_plugins` diff --git a/doc/source/contributing.rst b/doc/source/contributor/index.rst similarity index 53% rename from doc/source/contributing.rst rename to 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/history.rst b/doc/source/history.rst deleted file mode 100644 index 69ed4fe..0000000 --- a/doc/source/history.rst +++ /dev/null @@ -1 +0,0 @@ -.. include:: ../../ChangeLog diff --git a/doc/source/index.rst b/doc/source/index.rst index f53e5bd..4929168 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -6,12 +6,10 @@ Contents .. toctree:: :maxdepth: 2 - installation - api - healthcheck_plugins - cors - oslo_config - contributing + install/index + contributor/index + configuration/index + reference/index Release Notes ============= @@ -19,4 +17,4 @@ Release Notes .. toctree:: :maxdepth: 1 - history + user/history 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.rst b/doc/source/reference/api.rst similarity index 100% rename from doc/source/api.rst rename to doc/source/reference/api.rst diff --git a/doc/source/cors.rst b/doc/source/reference/cors.rst similarity index 100% rename from doc/source/cors.rst rename to doc/source/reference/cors.rst diff --git a/doc/source/healthcheck_plugins.rst b/doc/source/reference/healthcheck_plugins.rst similarity index 100% rename from doc/source/healthcheck_plugins.rst rename to doc/source/reference/healthcheck_plugins.rst diff --git a/doc/source/reference/index.rst b/doc/source/reference/index.rst new file mode 100644 index 0000000..5a2d80a --- /dev/null +++ b/doc/source/reference/index.rst @@ -0,0 +1,8 @@ +============================== + oslo.middleware Reference +============================== + +.. toctree:: + :glob: + + * diff --git a/doc/source/user/history.rst b/doc/source/user/history.rst new file mode 100644 index 0000000..f69be70 --- /dev/null +++ b/doc/source/user/history.rst @@ -0,0 +1 @@ +.. include:: ../../../ChangeLog