From dc98986c0cacfdf10e8f22ad9c3fb804cc2c37d3 Mon Sep 17 00:00:00 2001 From: Julien Date: Wed, 17 Aug 2016 22:59:18 +0800 Subject: [PATCH] Update according DOCS Each path use a index.rst file to include all the rst files: 1). Add missing index.rst 2). Rename some file to index.rst 3). Ude a index.rst to include all the community labs(currently all the labs are at the top level) Change-Id: I9bb6903328a8d445121982dd662df9eeceb23ff5 Signed-off-by: Julien --- docs/configguide/{pharosconfig.rst => index.rst} | 0 docs/index.rst | 17 +++++------------ docs/information/index.rst | 14 ++++++++++++++ docs/information/pharos.rst | 7 ------- docs/lab-description/{templates.rst => index.rst} | 1 + docs/labs/index.rst | 20 ++++++++++++++++++++ docs/labs/ool/{ool.rst => index.rst} | 0 .../orange-paris-lab/{orange_paris.rst => index.rst} | 0 docs/labs/zte-nj-lab/{zte-nj.rst => index.rst} | 0 docs/labs/zte-sh-lab/{zte-sh.rst => index.rst} | 0 10 files changed, 40 insertions(+), 19 deletions(-) rename docs/configguide/{pharosconfig.rst => index.rst} (100%) create mode 100644 docs/information/index.rst rename docs/lab-description/{templates.rst => index.rst} (98%) create mode 100755 docs/labs/index.rst rename docs/labs/ool/{ool.rst => index.rst} (100%) rename docs/labs/orange-paris-lab/{orange_paris.rst => index.rst} (100%) rename docs/labs/zte-nj-lab/{zte-nj.rst => index.rst} (100%) rename docs/labs/zte-sh-lab/{zte-sh.rst => index.rst} (100%) diff --git a/docs/configguide/pharosconfig.rst b/docs/configguide/index.rst similarity index 100% rename from docs/configguide/pharosconfig.rst rename to docs/configguide/index.rst diff --git a/docs/index.rst b/docs/index.rst index 36b48f52..94844fa9 100755 --- a/docs/index.rst +++ b/docs/index.rst @@ -17,19 +17,12 @@ OPNFV Community Lab Infrastructure :maxdepth: 3 :numbered: 3 - ./information/pharos.rst - ./specification/pharosspec.rst - ./lab-description/templates.rst - ./configguide/pharosconfig.rst - ./labs/Dell.rst - ./labs/huawei-us-lab/huawei-us-lab.rst - ./labs/ool/ool.rst - ./labs/orange-paris-lab/orange_paris.rst - ./labs/spirent.rst - ./labs/zte-nj-lab/zte-nj.rst - ./labs/zte-sh-lab/zte-sh.rst + ./information/index.rst + ./specification/index.rst + ./lab-description/index.rst + ./configguide/index.rst + ./labs/index.rst Indices ======= * :ref:`search` - diff --git a/docs/information/index.rst b/docs/information/index.rst new file mode 100644 index 00000000..0311526a --- /dev/null +++ b/docs/information/index.rst @@ -0,0 +1,14 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 +.. (c) 2016 OPNFV. + + +************************** +Pharos Project Information +************************** + + +.. toctree:: + :maxdepth: 2 + + ./pharos.rst diff --git a/docs/information/pharos.rst b/docs/information/pharos.rst index 24e46d97..3a250c5c 100644 --- a/docs/information/pharos.rst +++ b/docs/information/pharos.rst @@ -2,13 +2,6 @@ .. http://creativecommons.org/licenses/by/4.0 .. (c) 2016 OPNFV. -.. OPNFV Pharos Project Information file. - -.. _pharos_information: - -************************** -Pharos Project Information -************************** Introduction ------------ diff --git a/docs/lab-description/templates.rst b/docs/lab-description/index.rst similarity index 98% rename from docs/lab-description/templates.rst rename to docs/lab-description/index.rst index 33cc5559..1dfacc8a 100644 --- a/docs/lab-description/templates.rst +++ b/docs/lab-description/index.rst @@ -21,6 +21,7 @@ This is the "POD inventory" common format file. .. toctree:: + :maxdepth: 2 ./lab_description.rst ./pod_description.rst diff --git a/docs/labs/index.rst b/docs/labs/index.rst new file mode 100755 index 00000000..2d6ece49 --- /dev/null +++ b/docs/labs/index.rst @@ -0,0 +1,20 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 +.. (c) 2016 OPNFV. + + +===================== +PHAROS Community Labs +===================== + + +.. toctree:: + :maxdepth: 2 + + ./Dell.rst + ./huawei-us-lab/huawei-us-lab.rst + ./ool/index.rst + ./orange-paris-lab/index.rst + ./spirent.rst + ./zte-nj-lab/index.rst + ./zte-sh-lab/index.rst diff --git a/docs/labs/ool/ool.rst b/docs/labs/ool/index.rst similarity index 100% rename from docs/labs/ool/ool.rst rename to docs/labs/ool/index.rst diff --git a/docs/labs/orange-paris-lab/orange_paris.rst b/docs/labs/orange-paris-lab/index.rst similarity index 100% rename from docs/labs/orange-paris-lab/orange_paris.rst rename to docs/labs/orange-paris-lab/index.rst diff --git a/docs/labs/zte-nj-lab/zte-nj.rst b/docs/labs/zte-nj-lab/index.rst similarity index 100% rename from docs/labs/zte-nj-lab/zte-nj.rst rename to docs/labs/zte-nj-lab/index.rst diff --git a/docs/labs/zte-sh-lab/zte-sh.rst b/docs/labs/zte-sh-lab/index.rst similarity index 100% rename from docs/labs/zte-sh-lab/zte-sh.rst rename to docs/labs/zte-sh-lab/index.rst -- 2.16.6