From 7b051407297547bdc7f56a42a5903bbd2655446a Mon Sep 17 00:00:00 2001 From: Ryota MIBU Date: Thu, 25 Feb 2016 22:19:02 +0900 Subject: docs: add index.rst files to component docs Change-Id: I1256d21bc01c7f1343859e28b47c15d9d284bddf Signed-off-by: Ryota MIBU (cherry picked from commit 5996a35d07d1a5c661adb3af37c4e6eb4f4a5331) --- docs/configguide/index.rst | 12 ++++++++++++ docs/manuals/index.rst | 2 +- docs/platformoverview/index.rst | 12 ++++++++++++ docs/test4composite/configguide.rst | 4 ---- docs/test4composite/images | 1 - docs/test4composite/index.rst | 20 -------------------- docs/test4composite/platformoverview.rst | 4 ---- docs/test4composite/userguide.rst | 4 ---- docs/userguide/index.rst | 12 ++++++++++++ 9 files changed, 37 insertions(+), 34 deletions(-) create mode 100644 docs/configguide/index.rst create mode 100644 docs/platformoverview/index.rst delete mode 100644 docs/test4composite/configguide.rst delete mode 120000 docs/test4composite/images delete mode 100644 docs/test4composite/index.rst delete mode 100644 docs/test4composite/platformoverview.rst delete mode 100644 docs/test4composite/userguide.rst create mode 100644 docs/userguide/index.rst 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/configguide.rst b/docs/test4composite/configguide.rst deleted file mode 100644 index d1f89634..00000000 --- a/docs/test4composite/configguide.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:: ../configguide/featureconfig.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/userguide/index.rst b/docs/userguide/index.rst new file mode 100644 index 00000000..43726ea3 --- /dev/null +++ b/docs/userguide/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 User Guide +***************** + +.. toctree:: + :maxdepth: 2 + :numbered: + +.. include:: featureusage.rst -- cgit 1.2.3-korg