summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorRyota MIBU <r-mibu@cq.jp.nec.com>2016-02-25 22:19:02 +0900
committerRyota MIBU <r-mibu@cq.jp.nec.com>2016-02-25 22:33:20 +0900
commit5996a35d07d1a5c661adb3af37c4e6eb4f4a5331 (patch)
tree48e7ea177d42132b7a92c16090f4d6a0777d0f34
parenta3ea372e18ef14b75734f82db969531df6d0c7dd (diff)
docs: add index.rst files to component docs
Change-Id: I1256d21bc01c7f1343859e28b47c15d9d284bddf Signed-off-by: Ryota MIBU <r-mibu@cq.jp.nec.com>
-rw-r--r--docs/configguide/index.rst12
-rw-r--r--docs/manuals/index.rst2
-rw-r--r--docs/platformoverview/index.rst12
l---------docs/test4composite/images1
-rw-r--r--docs/test4composite/index.rst20
-rw-r--r--docs/test4composite/platformoverview.rst4
-rw-r--r--docs/test4composite/userguide.rst4
-rw-r--r--docs/userguide/index.rst (renamed from docs/test4composite/configguide.rst)10
8 files changed, 34 insertions, 31 deletions
diff --git a/docs/configguide/index.rst b/docs/configguide/index.rst
new file mode 100644
index 00000000..4a7a5fbe
--- /dev/null
+++ b/docs/configguide/index.rst
@@ -0,0 +1,12 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+
+**************************
+Doctor Configuration Guide
+**************************
+
+.. toctree::
+ :maxdepth: 2
+ :numbered:
+
+.. include:: featureconfig.rst
diff --git a/docs/manuals/index.rst b/docs/manuals/index.rst
index cbed5fdf..52d36096 100644
--- a/docs/manuals/index.rst
+++ b/docs/manuals/index.rst
@@ -9,4 +9,4 @@ Manuals
:numbered:
:maxdepth: 2
- mark-host-down_manual.rst
+.. include:: mark-host-down_manual.rst
diff --git a/docs/platformoverview/index.rst b/docs/platformoverview/index.rst
new file mode 100644
index 00000000..23d61cd4
--- /dev/null
+++ b/docs/platformoverview/index.rst
@@ -0,0 +1,12 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+
+************************
+Doctor Platform Overview
+************************
+
+.. toctree::
+ :maxdepth: 2
+ :numbered:
+
+.. include:: platformoverview.rst
diff --git a/docs/test4composite/images b/docs/test4composite/images
deleted file mode 120000
index 70631720..00000000
--- a/docs/test4composite/images
+++ /dev/null
@@ -1 +0,0 @@
-../platformoverview/images \ No newline at end of file
diff --git a/docs/test4composite/index.rst b/docs/test4composite/index.rst
deleted file mode 100644
index 5b176773..00000000
--- a/docs/test4composite/index.rst
+++ /dev/null
@@ -1,20 +0,0 @@
-.. This work is licensed under a Creative Commons Attribution 4.0 International License.
-.. http://creativecommons.org/licenses/by/4.0
-
-*********************************
-Doctor contents in composite docs
-*********************************
-
-.. note::
- This document is just for test to validate doctor contents which would
- be included into the OPNFV composite docs.
-
-.. toctree::
- :maxdepth: 2
- :numbered:
-
- *
-
-.. include:: ../platformoverview/platformoverview.rst
-.. include:: ../configguide/featureconfig.rst
-.. include:: ../userguide/userguide.rst
diff --git a/docs/test4composite/platformoverview.rst b/docs/test4composite/platformoverview.rst
deleted file mode 100644
index 2473f673..00000000
--- a/docs/test4composite/platformoverview.rst
+++ /dev/null
@@ -1,4 +0,0 @@
-.. This work is licensed under a Creative Commons Attribution 4.0 International License.
-.. http://creativecommons.org/licenses/by/4.0
-
-.. include:: ../platformoverview/platformoverview.rst
diff --git a/docs/test4composite/userguide.rst b/docs/test4composite/userguide.rst
deleted file mode 100644
index e05aec11..00000000
--- a/docs/test4composite/userguide.rst
+++ /dev/null
@@ -1,4 +0,0 @@
-.. This work is licensed under a Creative Commons Attribution 4.0 International License.
-.. http://creativecommons.org/licenses/by/4.0
-
-.. include:: ../userguide/userguide.rst
diff --git a/docs/test4composite/configguide.rst b/docs/userguide/index.rst
index d1f89634..43726ea3 100644
--- a/docs/test4composite/configguide.rst
+++ b/docs/userguide/index.rst
@@ -1,4 +1,12 @@
.. This work is licensed under a Creative Commons Attribution 4.0 International License.
.. http://creativecommons.org/licenses/by/4.0
-.. include:: ../configguide/featureconfig.rst
+*****************
+Doctor User Guide
+*****************
+
+.. toctree::
+ :maxdepth: 2
+ :numbered:
+
+.. include:: featureusage.rst