summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorRyota MIBU <r-mibu@cq.jp.nec.com>2016-02-10 12:53:08 +0900
committerChristopher Price <christopher.price@ericsson.com>2016-02-11 10:52:48 +0000
commit14fa6b031e9cd44773bcdb120ab92055b5fbedf0 (patch)
tree3e925263edcf09e2fefa625ac3fd32bdffa36754
parent325382117d27b5cb15b8b21bc6b61e6af86d5553 (diff)
WIP: script: gather feature config guides automatically
Change-Id: Iedc50c723ee3ec0fa0e07848d633d35c67d5aa94 Signed-off-by: Ryota MIBU <r-mibu@cq.jp.nec.com> (cherry picked from commit 6bd42c59ae30c30b460f6e69171e71a4e4f9c541)
-rwxr-xr-xbuild-composite.sh41
-rw-r--r--docs/configguide/feature-config.rst20
-rw-r--r--docs/configguide/featureconfig-copper.rst4
-rw-r--r--docs/configguide/featureconfig-doctor.rst4
-rw-r--r--docs/configguide/featureconfig-ipv6.rst4
-rw-r--r--docs/configguide/featureconfig-promise.rst4
-rw-r--r--docs/configguide/featureconfig-sdnvpn.rst4
7 files changed, 26 insertions, 55 deletions
diff --git a/build-composite.sh b/build-composite.sh
index 4aef8602a..574c4ecd9 100755
--- a/build-composite.sh
+++ b/build-composite.sh
@@ -70,21 +70,32 @@ 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"
-#echo
-#for guide in configguide userguide
-#do
-# link_list=$WORKSPACE/docs/$guide/projects-$guide.rst
-# for repo in $repos
-# do
-# file=projects/$repo/$guide/$guide.rst
-# [[ -e $WORKSPACE/docs/$file ]] || continue
-# echo "" >> $link_list
-# echo "$repo:" >> $link_list
-# echo ".. include:: ../$file" >> $link_list
-# done
-#done
+echo
+echo "Creating document links"
+echo
+#for guide in configguide/installer-config.rst configguide/feature-config.rst \
+# configguide/postinatall.rst \
+# userguide/feature-usage.rst userguide/test-usage.rst
+for guide in configguide/feature-config.rst
+do
+ mainfile="$WORKSPACE/docs/$guide"
+ for repo in $repos
+ do
+ projectfile="projects/$repo/${guide//-/}"
+ projectlink="${mainfile%/*}/featureconfig-$repo.rst"
+ [[ -e "$WORKSPACE/docs/$projectfile" ]] || continue
+ echo "Adding $repo to $guide ..."
+ echo "" >> $mainfile
+ echo ".. toctree::" >> $mainfile
+ echo "" >> $mainfile
+ echo " $projectlink" >> $mainfile
+ echo ".. include:: ../$projectfile" >> $projectlink
+ done
+ echo
+ echo "Generated $guide:"
+ cat $mainfile
+ echo
+done
$WORKSPACE/releng/utils/docs-build.sh
diff --git a/docs/configguide/feature-config.rst b/docs/configguide/feature-config.rst
index 96409b85c..29e7e09cf 100644
--- a/docs/configguide/feature-config.rst
+++ b/docs/configguide/feature-config.rst
@@ -8,23 +8,3 @@ 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.
-
-.. 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
deleted file mode 100644
index 5a348deaa..000000000
--- a/docs/configguide/featureconfig-copper.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:: ../projects/copper/configguide/featureconfig.rst
diff --git a/docs/configguide/featureconfig-doctor.rst b/docs/configguide/featureconfig-doctor.rst
deleted file mode 100644
index ef9906457..000000000
--- a/docs/configguide/featureconfig-doctor.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:: ../projects/doctor/configguide/configguide.rst
diff --git a/docs/configguide/featureconfig-ipv6.rst b/docs/configguide/featureconfig-ipv6.rst
deleted file mode 100644
index 49211f517..000000000
--- a/docs/configguide/featureconfig-ipv6.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:: ../projects/ipv6/configguide/featureconfig.rst
diff --git a/docs/configguide/featureconfig-promise.rst b/docs/configguide/featureconfig-promise.rst
deleted file mode 100644
index bd1d7f5d3..000000000
--- a/docs/configguide/featureconfig-promise.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:: ../projects/promise/configguide/featureconfig.rst
diff --git a/docs/configguide/featureconfig-sdnvpn.rst b/docs/configguide/featureconfig-sdnvpn.rst
deleted file mode 100644
index dc4d2d970..000000000
--- a/docs/configguide/featureconfig-sdnvpn.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:: ../projects/sdnvpn/configguide/configguide.rst