summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDong Ma <winterma.dong@gmail.com>2017-06-26 23:14:19 +0800
committerDong Ma <winterma.dong@gmail.com>2017-06-26 23:22:28 +0800
commita2780e0cfcc30eab63cd3b90f4827df5e30616df (patch)
treea580fb05028246ac89158845ce3ae066d2cc80c4
parent3d6505374192840b23ff6e955a4519ba99daa677 (diff)
downloadoslo-middleware-a2780e0cfcc30eab63cd3b90f4827df5e30616df.tar.gz
rearrange content to fit the new standard layout
Change-Id: I299b6da1fcb8a7a6a6524cfa5d9892a6c2643c18 Depends-On: Ia750cb049c0f53a234ea70ce1f2bbbb7a2aa9454
-rw-r--r--doc/source/configuration/index.rst (renamed from doc/source/oslo_config.rst)2
-rw-r--r--doc/source/contributor/index.rst (renamed from doc/source/contributing.rst)2
-rw-r--r--doc/source/history.rst1
-rw-r--r--doc/source/index.rst12
-rw-r--r--doc/source/install/index.rst (renamed from doc/source/installation.rst)0
-rw-r--r--doc/source/reference/api.rst (renamed from doc/source/api.rst)0
-rw-r--r--doc/source/reference/cors.rst (renamed from doc/source/cors.rst)0
-rw-r--r--doc/source/reference/healthcheck_plugins.rst (renamed from doc/source/healthcheck_plugins.rst)0
-rw-r--r--doc/source/reference/index.rst8
-rw-r--r--doc/source/user/history.rst1
10 files changed, 16 insertions, 10 deletions
diff --git a/doc/source/oslo_config.rst b/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
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
index 4fd1d47..4fd1d47 100644
--- a/doc/source/installation.rst
+++ b/doc/source/install/index.rst
diff --git a/doc/source/api.rst b/doc/source/reference/api.rst
index 50ad06d..50ad06d 100644
--- a/doc/source/api.rst
+++ b/doc/source/reference/api.rst
diff --git a/doc/source/cors.rst b/doc/source/reference/cors.rst
index 77bb6ed..77bb6ed 100644
--- a/doc/source/cors.rst
+++ b/doc/source/reference/cors.rst
diff --git a/doc/source/healthcheck_plugins.rst b/doc/source/reference/healthcheck_plugins.rst
index 3ea93c5..3ea93c5 100644
--- a/doc/source/healthcheck_plugins.rst
+++ b/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