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 <r-mibu@cq.jp.nec.com>
(cherry picked from commit b7519539bf10181d248b69486c490df46693b209)

diff --git a/build-composite.sh b/build-composite.sh
index 2303a5b..4aef860 100755 (executable)
--- 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 992f501..96409b8 100644 (file)
--- 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 (file)
index 0000000..5a348de
--- /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 (file)
index 0000000..ef99064
--- /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 (file)
index 0000000..49211f5
--- /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 (file)
index 0000000..bd1d7f5
--- /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 (file)
index 0000000..dc4d2d9
--- /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 7d84f9e..ad10cb4 100644 (file)
--- 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 (file)
index 0000000..2729565
--- /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 (file)
index 0000000..2a66ea1
--- /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 (file)
index 0000000..cd4e5e2
--- /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 741905a..0eca4ba 100644 (file)
--- 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 (file)
index 0000000..06c4b15
--- /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 (file)
index 0000000..1bdced4
--- /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 (file)
index 0000000..8a51452
--- /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 (file)
index 0000000..d986b6f
--- /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 (file)
index 0000000..e241d49
--- /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