From 9aa067edbc409c04be0de4fc0c2abfa0b157af4d Mon Sep 17 00:00:00 2001 From: Ryota MIBU Date: Mon, 8 Feb 2016 20:32:33 +0900 Subject: [PATCH] configguide: make sections relevant by adding sub-level toctree This patch wrap each import document with 'toctree' directive so that we can make sure the sections in imported docs won't take any upper level section. This patch also fixes the followings: * path to copper/featureconfig.rst * path to promise/configguide/images/ Change-Id: I52d4e9cd637af5707af418ef287d57d8c301b85e Signed-off-by: Ryota MIBU (cherry picked from commit b7519539bf10181d248b69486c490df46693b209) --- build-composite.sh | 4 ++++ docs/configguide/feature-config.rst | 23 ++++++++++++++++++----- docs/configguide/featureconfig-copper.rst | 4 ++++ docs/configguide/featureconfig-doctor.rst | 4 ++++ docs/configguide/featureconfig-ipv6.rst | 4 ++++ docs/configguide/featureconfig-promise.rst | 4 ++++ docs/configguide/featureconfig-sdnvpn.rst | 4 ++++ docs/configguide/installer-config.rst | 14 ++++++++++---- docs/configguide/installerconfig-apex.rst | 11 +++++++++++ docs/configguide/installerconfig-fuel.rst | 4 ++++ docs/configguide/installerconfig-joid.rst | 4 ++++ docs/configguide/post-install.rst | 21 ++++++++++++++++----- docs/configguide/postinstall-copper.rst | 4 ++++ docs/configguide/postinstall-functest.rst | 4 ++++ docs/configguide/postinstall-ipv6.rst | 4 ++++ docs/configguide/postinstall-joid.rst | 4 ++++ docs/configguide/postinstall-vswitchperf.rst | 4 ++++ 17 files changed, 107 insertions(+), 14 deletions(-) create mode 100644 docs/configguide/featureconfig-copper.rst create mode 100644 docs/configguide/featureconfig-doctor.rst create mode 100644 docs/configguide/featureconfig-ipv6.rst create mode 100644 docs/configguide/featureconfig-promise.rst create mode 100644 docs/configguide/featureconfig-sdnvpn.rst create mode 100644 docs/configguide/installerconfig-apex.rst create mode 100644 docs/configguide/installerconfig-fuel.rst create mode 100644 docs/configguide/installerconfig-joid.rst create mode 100644 docs/configguide/postinstall-copper.rst create mode 100644 docs/configguide/postinstall-functest.rst create mode 100644 docs/configguide/postinstall-ipv6.rst create mode 100644 docs/configguide/postinstall-joid.rst create mode 100644 docs/configguide/postinstall-vswitchperf.rst diff --git a/build-composite.sh b/build-composite.sh index 2303a5b83..4aef8602a 100755 --- a/build-composite.sh +++ b/build-composite.sh @@ -65,6 +65,10 @@ done # NOTE: Removing index.rst in project repos to reduce number of docs. find docs/projects -type f -name 'index.rst' -print | xargs -I i rm -f i +# Correct Image file path (workaround) +sed -i -e '/^.. figure::/s|images|../projects/promise/configguide/images|' \ + docs/projects/promise/configguide/featureconfig.rst + # NOTE: automated link generation is not ready... #echo #echo "Creating document links" diff --git a/docs/configguide/feature-config.rst b/docs/configguide/feature-config.rst index 992f501b6..96409b85c 100644 --- a/docs/configguide/feature-config.rst +++ b/docs/configguide/feature-config.rst @@ -9,9 +9,22 @@ Feature Configuration The following sections describe the configuration options for specific platform features provided in Brahmaputra. Further details for each feature are captured in the referred project documentation. -.. include:: ../projects/copper/configguide/configguide.rst -.. include:: ../projects/doctor/configguide/configguide.rst -.. include:: ../projects/ipv6/configguide/featureconfig.rst -.. include:: ../projects/promise/configguide/featureconfig.rst -.. include:: ../projects/sdnvpn/configguide/configguide.rst +.. toctree:: + featureconfig-copper + +.. toctree:: + + featureconfig-doctor + +.. toctree:: + + featureconfig-ipv6 + +.. toctree:: + + featureconfig-promise + +.. toctree:: + + featureconfig-sdnvpn diff --git a/docs/configguide/featureconfig-copper.rst b/docs/configguide/featureconfig-copper.rst new file mode 100644 index 000000000..5a348deaa --- /dev/null +++ b/docs/configguide/featureconfig-copper.rst @@ -0,0 +1,4 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 + +.. include:: ../projects/copper/configguide/featureconfig.rst diff --git a/docs/configguide/featureconfig-doctor.rst b/docs/configguide/featureconfig-doctor.rst new file mode 100644 index 000000000..ef9906457 --- /dev/null +++ b/docs/configguide/featureconfig-doctor.rst @@ -0,0 +1,4 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 + +.. include:: ../projects/doctor/configguide/configguide.rst diff --git a/docs/configguide/featureconfig-ipv6.rst b/docs/configguide/featureconfig-ipv6.rst new file mode 100644 index 000000000..49211f517 --- /dev/null +++ b/docs/configguide/featureconfig-ipv6.rst @@ -0,0 +1,4 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 + +.. include:: ../projects/ipv6/configguide/featureconfig.rst diff --git a/docs/configguide/featureconfig-promise.rst b/docs/configguide/featureconfig-promise.rst new file mode 100644 index 000000000..bd1d7f5d3 --- /dev/null +++ b/docs/configguide/featureconfig-promise.rst @@ -0,0 +1,4 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 + +.. include:: ../projects/promise/configguide/featureconfig.rst diff --git a/docs/configguide/featureconfig-sdnvpn.rst b/docs/configguide/featureconfig-sdnvpn.rst new file mode 100644 index 000000000..dc4d2d970 --- /dev/null +++ b/docs/configguide/featureconfig-sdnvpn.rst @@ -0,0 +1,4 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 + +.. include:: ../projects/sdnvpn/configguide/configguide.rst diff --git a/docs/configguide/installer-config.rst b/docs/configguide/installer-config.rst index 7d84f9e1d..ad10cb4ae 100644 --- a/docs/configguide/installer-config.rst +++ b/docs/configguide/installer-config.rst @@ -9,8 +9,14 @@ Installer Configuration The following sections describe the per installer configuration options. Further details for each installer are captured in the referred project documentation. -.. include:: ../projects/apex/configguide/introduction.rst -.. include:: ../projects/apex/configguide/baremetalinstall.rst -.. include:: ../projects/fuel/configguide/installerconfig.rst -.. include:: ../projects/joid/configguide/installerconfig.rst +.. toctree:: + installerconfig-apex + +.. toctree:: + + installerconfig-fuel + +.. toctree:: + + installerconfig-joid diff --git a/docs/configguide/installerconfig-apex.rst b/docs/configguide/installerconfig-apex.rst new file mode 100644 index 000000000..272956540 --- /dev/null +++ b/docs/configguide/installerconfig-apex.rst @@ -0,0 +1,11 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 + +.. NOTE: this is workaround and has to be fixed in each project repo. + +================== +Apex configuration +================== + +.. include:: ../projects/apex/configguide/introduction.rst +.. include:: ../projects/apex/configguide/baremetalinstall.rst diff --git a/docs/configguide/installerconfig-fuel.rst b/docs/configguide/installerconfig-fuel.rst new file mode 100644 index 000000000..2a66ea1b0 --- /dev/null +++ b/docs/configguide/installerconfig-fuel.rst @@ -0,0 +1,4 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 + +.. include:: ../projects/fuel/configguide/installerconfig.rst diff --git a/docs/configguide/installerconfig-joid.rst b/docs/configguide/installerconfig-joid.rst new file mode 100644 index 000000000..cd4e5e254 --- /dev/null +++ b/docs/configguide/installerconfig-joid.rst @@ -0,0 +1,4 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 + +.. include:: ../projects/joid/configguide/installerconfig.rst diff --git a/docs/configguide/post-install.rst b/docs/configguide/post-install.rst index 741905a52..0eca4ba08 100644 --- a/docs/configguide/post-install.rst +++ b/docs/configguide/post-install.rst @@ -15,8 +15,13 @@ Scenario validation activities The following guides provide information on how to validate the installation of you scenario based on the tools and test suites available for the installation tool you have selected: -.. include:: ../projects/ipv6/configguide/postinstall.rst -.. include:: ../projects/joid/configguide/postinstall.rst +.. toctree:: + + postinstall-ipv6 + +.. toctree:: + + postinstall-joid Feature validation activities ============================= @@ -24,7 +29,9 @@ Feature validation activities The following sections provide information on how to validate the features you have installed in your scenario: -.. include:: ../projects/copper/configguide/postinstall.rst +.. toctree:: + + postinstall-copper Additional testing and validation activities ============================================ @@ -33,6 +40,10 @@ Many of our testing tools can be manually installed to facilitate targeted testi of features and capabilities of your scenario. The following guides provide instruction on setting up these testing suites: -.. include:: ../projects/functest/configguide/configguide.rst -.. include:: ../projects/vswitchperf/configguide/installation.rst +.. toctree:: + + postinstall-functest + +.. toctree:: + postinstall-vswitchperf diff --git a/docs/configguide/postinstall-copper.rst b/docs/configguide/postinstall-copper.rst new file mode 100644 index 000000000..06c4b151b --- /dev/null +++ b/docs/configguide/postinstall-copper.rst @@ -0,0 +1,4 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 + +.. include:: ../projects/copper/configguide/postinstall.rst diff --git a/docs/configguide/postinstall-functest.rst b/docs/configguide/postinstall-functest.rst new file mode 100644 index 000000000..1bdced4c4 --- /dev/null +++ b/docs/configguide/postinstall-functest.rst @@ -0,0 +1,4 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 + +.. include:: ../projects/functest/configguide/configguide.rst diff --git a/docs/configguide/postinstall-ipv6.rst b/docs/configguide/postinstall-ipv6.rst new file mode 100644 index 000000000..8a51452b6 --- /dev/null +++ b/docs/configguide/postinstall-ipv6.rst @@ -0,0 +1,4 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 + +.. include:: ../projects/ipv6/configguide/postinstall.rst diff --git a/docs/configguide/postinstall-joid.rst b/docs/configguide/postinstall-joid.rst new file mode 100644 index 000000000..d986b6f22 --- /dev/null +++ b/docs/configguide/postinstall-joid.rst @@ -0,0 +1,4 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 + +.. include:: ../projects/joid/configguide/postinstall.rst diff --git a/docs/configguide/postinstall-vswitchperf.rst b/docs/configguide/postinstall-vswitchperf.rst new file mode 100644 index 000000000..e241d4978 --- /dev/null +++ b/docs/configguide/postinstall-vswitchperf.rst @@ -0,0 +1,4 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 + +.. include:: ../projects/vswitchperf/configguide/installation.rst -- 2.16.6