Add submodule information summary when running tox

Add summary and advance sphinx requirement to latest stable release

Change-Id: I4aae9c9e54bed7943beba24d9cb57f1338974ddf
Issue-ID: DOC-332
Signed-off-by: Rich Bennett <rb2745@att.com>

diff --git a/docs/smsummary.rst b/docs/smsummary.rst
new file mode 100644 (file)
index 0000000..13e0e45
--- /dev/null
+++ b/docs/smsummary.rst
@@ -0,0 +1,10 @@
+.. This work is licensed under a Creative Commons Attribution 4.0
+.. International License. http://creativecommons.org/licenses/by/4.0
+.. Copyright 2017 AT&T Intellectual Property.  All rights reserved.
+
+Contributing Submodule Summary
+==============================
+
+.. code-block:: console
+   
+.. literalinclude:: _static/smsummary.out

diff --git a/etc/requirements.txt b/etc/requirements.txt
index 8e2894c..aecf5a3 100644 (file)
--- a/etc/requirements.txt
+++ b/etc/requirements.txt
@@ -1,5 +1,5 @@
 tox
-Sphinx==1.6.7
+Sphinx==1.8.1
 doc8
 docutils
 setuptools

diff --git a/shell/smsummary.sh b/shell/smsummary.sh
new file mode 100644 (file)
index 0000000..a4bd1d3
--- /dev/null
+++ b/shell/smsummary.sh
@@ -0,0 +1,26 @@
+# Copyright (c) 2018 Open Network Automation Platform and contributors
+#
+#  Licensed under the Apache License, Version 2.0 (the "License");
+#  you may not use this file except in compliance with the License.
+#  You may obtain a copy of the License at
+#
+#           http://www.apache.org/licenses/LICENSE-2.0
+#
+#  Unless required by applicable law or agreed to in writing,
+#  software distributed under the License is distributed on an
+#  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
+#  either express or implied. See the License for the specific
+#  language governing permissions and limitations under the License.
+
+# Create a list of submodules used to build documentation
+# Usage:   sh smsummary.sh output_file
+#
+
+echo "************************************************************************************" > $1
+echo "* Submodule branches used to build this version of the documentation.              *" >> $1
+echo "************************************************************************************" >> $1
+
+git submodule foreach git for-each-ref \
+  --format='%(committerdate:iso8601) %(objectname) %(HEAD) %(refname) %(subject)' \
+  --sort -committerdate refs/heads/ | \
+  sed -e 's:^:       :' -e 's:       Entering .docs/submodules/::' -e 's:.git.$::' -e 's:refs/heads/::' >> $1

diff --git a/tox.ini b/tox.ini
index 574ff4e..f60f9ed 100644 (file)
--- a/tox.ini
+++ b/tox.ini
@@ -6,9 +6,14 @@ skipsdist = true
 [testenv:docs]
 deps = -r{toxinidir}/etc/requirements.txt
 commands =
+    sh {toxinidir}/shell/smsummary.sh  {toxinidir}/docs/_static/smsummary.out
+    echo "Summary of submodule versions used in html build in {toxinidir}/docs/_static/smsummary.out"
     sphinx-build -j 3 -b html -n -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/html
     echo "Generated docs available in {toxinidir}/docs/_build/html"
-whitelist_externals = echo
+whitelist_externals =
+    echo
+    git
+    sh
 
 [testenv:local]
 deps = -r{toxinidir}/etc/requirements.txt