From a61abf1b5bf55d6dc4d0814c2b44d7279d2090e8 Mon Sep 17 00:00:00 2001 From: Rich Bennett Date: Mon, 12 Nov 2018 09:07:41 -0500 Subject: [PATCH] Update submodule repo casablanca refs Update submodule references to track casablanca branches Eliminate parallel sphinx-build threads DOC-334 Create submodule reference summary in tox -e doc DOC-332 Include master updates from https://gerrit.onap.org/r/#/c/72254/ Change admonition on top level page to Under Construction Update release name in docs/conf.py Issue-ID: DOC-335 Change-Id: Ia8f42c6f01f7fac09b72c95e72e939d3c154e437 Signed-off-by: Rich Bennett --- docs/conf.py | 4 ++-- docs/index.rst | 12 ++++------ docs/release/index.rst | 18 +++++++-------- docs/smsummary.rst | 10 ++++++++ docs/submodules/aai/event-client.git | 2 +- docs/submodules/aai/sparky-be.git | 2 +- docs/submodules/ccsdk/distribution.git | 2 +- docs/submodules/ccsdk/parent.git | 2 +- docs/submodules/ccsdk/platform/plugins.git | 2 +- .../dmaap/messagerouter/messageservice.git | 2 +- docs/submodules/logging-analytics.git | 2 +- docs/submodules/music.git | 2 +- docs/submodules/optf/has.git | 2 +- docs/submodules/optf/osdf.git | 2 +- docs/submodules/so/libs.git | 2 +- docs/submodules/vnfrqts/requirements.git | 2 +- docs/submodules/vnfrqts/testcases.git | 2 +- etc/requirements.txt | 2 +- shell/smsummary.sh | 27 ++++++++++++++++++++++ tox.ini | 9 ++++++-- 20 files changed, 72 insertions(+), 36 deletions(-) create mode 100644 docs/smsummary.rst create mode 100644 shell/smsummary.sh diff --git a/docs/conf.py b/docs/conf.py index fc96b8b4e..766271f9c 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -76,9 +76,9 @@ author = u'Open Network Automation Platform' # |version| and |release|, also used in various other places throughout the # built documents. # The short X.Y version. -version = 'master branch' +version = 'casablanca' # The full version, including alpha/beta/rc tags. -release = 'master branch' +release = 'casablanca' # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. diff --git a/docs/index.rst b/docs/index.rst index ba1f62aab..3eac605ce 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -5,14 +5,10 @@ ONAP Documentation ================== -.. caution:: - This version of documentation is created from the latest master branch of - source repositories, includes a proposed theme change, and is not a stable release. - To get the current stable release use one of the following - - * http://docs.onap.org - * http://docs.onap.org/en/beijing - * the selector on the bottom right and select beijing +.. important:: + Casablanca Release Documentation + + ** UNDER CONSTRUCTION ** .. toctree:: :maxdepth: 2 diff --git a/docs/release/index.rst b/docs/release/index.rst index 1f48857be..323bd3e64 100644 --- a/docs/release/index.rst +++ b/docs/release/index.rst @@ -1,19 +1,15 @@ .. This work is licensed under a Creative Commons Attribution 4.0 International License. http://creativecommons.org/licenses/by/4.0 -.. contents:: - :depth: 2 - -.. index:: Release Notes - Casablanca Release Notes ^^^^^^^^^^^^^^^^^^^^^^^^ This page is the ONAP Casablanca Release Notes. The first release was labelled -Amsterdam, second release Beijing and subsequent major release will be named using city names. +Amsterdam, second release Beijing and subsequent major release will be named +using city names. * Release Name: Casablanca * Release Version: 3.0.0 -* Release Date: Nov xx, 2018 +* Release Date: Nov 30, 2018 Getting Started With ONAP @@ -39,7 +35,7 @@ and run time environments, based on the user’s role. **Design Time Framework** - a comprehensive development environment with tools, techniques, and repositories for defining/describing resources, -services, and products: +and services: - Service Design and Creation (SDC) provides tools, techniques, and repositories to define/simulate/certify system assets as well as their @@ -122,9 +118,11 @@ Installation ============ There are 3 approaches to install ONAP: -* :ref:`Installation using Kubernetes (aka OOM) `. Recommended method. +* :ref:`Installation using Kubernetes (aka OOM) `. + Recommended method. * :ref:`Installation using Heat template `. -* :ref:`Advanced installation to install individual components `. +* :ref:`Advanced installation to install individual components + `. Documentation ============= diff --git a/docs/smsummary.rst b/docs/smsummary.rst new file mode 100644 index 000000000..13e0e4563 --- /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/docs/submodules/aai/event-client.git b/docs/submodules/aai/event-client.git index 14eddc2cc..0e52f7e49 160000 --- a/docs/submodules/aai/event-client.git +++ b/docs/submodules/aai/event-client.git @@ -1 +1 @@ -Subproject commit 14eddc2cc36b4c64782c7b1ea7a1abd6be1c2f2f +Subproject commit 0e52f7e4939820808d7c849aaf64cfbbd187f7e8 diff --git a/docs/submodules/aai/sparky-be.git b/docs/submodules/aai/sparky-be.git index 30643d72e..847b9d464 160000 --- a/docs/submodules/aai/sparky-be.git +++ b/docs/submodules/aai/sparky-be.git @@ -1 +1 @@ -Subproject commit 30643d72ec44dddb06a17d5ad29b0c45e90a445c +Subproject commit 847b9d464fe26ac3bca915cbda65bc0e55b61677 diff --git a/docs/submodules/ccsdk/distribution.git b/docs/submodules/ccsdk/distribution.git index 424327075..7e9bf97e8 160000 --- a/docs/submodules/ccsdk/distribution.git +++ b/docs/submodules/ccsdk/distribution.git @@ -1 +1 @@ -Subproject commit 424327075cba872296535ffbfe69f32c228b218a +Subproject commit 7e9bf97e8ae8dd7a4da324af175c7969fa0f9c24 diff --git a/docs/submodules/ccsdk/parent.git b/docs/submodules/ccsdk/parent.git index 5e50437a1..efca2079c 160000 --- a/docs/submodules/ccsdk/parent.git +++ b/docs/submodules/ccsdk/parent.git @@ -1 +1 @@ -Subproject commit 5e50437a127d861e044a4d25e55ac63585ccc6b5 +Subproject commit efca2079cd4dc3e7cd09a077db0c79c61d055657 diff --git a/docs/submodules/ccsdk/platform/plugins.git b/docs/submodules/ccsdk/platform/plugins.git index ac39f88aa..5cb7beb34 160000 --- a/docs/submodules/ccsdk/platform/plugins.git +++ b/docs/submodules/ccsdk/platform/plugins.git @@ -1 +1 @@ -Subproject commit ac39f88aa15b511dab1230720057b9737d38c102 +Subproject commit 5cb7beb34ee10ef1a7c8363b9dd8fc3016151c66 diff --git a/docs/submodules/dmaap/messagerouter/messageservice.git b/docs/submodules/dmaap/messagerouter/messageservice.git index 9072eeb0c..f3f0a2c77 160000 --- a/docs/submodules/dmaap/messagerouter/messageservice.git +++ b/docs/submodules/dmaap/messagerouter/messageservice.git @@ -1 +1 @@ -Subproject commit 9072eeb0cff6005902d0d21b3e5653e284288122 +Subproject commit f3f0a2c774047136c8f580ad811c2e60f6218eac diff --git a/docs/submodules/logging-analytics.git b/docs/submodules/logging-analytics.git index 60de689fa..236edd3c4 160000 --- a/docs/submodules/logging-analytics.git +++ b/docs/submodules/logging-analytics.git @@ -1 +1 @@ -Subproject commit 60de689fa4c16807d69646f5604d7ed1042f1dca +Subproject commit 236edd3c4665ffce1bcd832c5cf73739e77e77cd diff --git a/docs/submodules/music.git b/docs/submodules/music.git index 98e3809b5..287bdcbb5 160000 --- a/docs/submodules/music.git +++ b/docs/submodules/music.git @@ -1 +1 @@ -Subproject commit 98e3809b59399dbe8174d97cdf3367beb475e53a +Subproject commit 287bdcbb5482f94df091c3b7b766fed0007efa2e diff --git a/docs/submodules/optf/has.git b/docs/submodules/optf/has.git index ed7c491c3..633927402 160000 --- a/docs/submodules/optf/has.git +++ b/docs/submodules/optf/has.git @@ -1 +1 @@ -Subproject commit ed7c491c37db044b07ab97781a2d8cab63bcfe99 +Subproject commit 633927402f317714069ae71e0ee766a0d54194ed diff --git a/docs/submodules/optf/osdf.git b/docs/submodules/optf/osdf.git index 99be035a2..b05fb22d9 160000 --- a/docs/submodules/optf/osdf.git +++ b/docs/submodules/optf/osdf.git @@ -1 +1 @@ -Subproject commit 99be035a26a198d676547c9f88c56f1f0c37b697 +Subproject commit b05fb22d90def79369e37f4e08ae19595317421a diff --git a/docs/submodules/so/libs.git b/docs/submodules/so/libs.git index d184b2b86..bd6f4ae22 160000 --- a/docs/submodules/so/libs.git +++ b/docs/submodules/so/libs.git @@ -1 +1 @@ -Subproject commit d184b2b864673755acec7acdf35f7687b1b13dec +Subproject commit bd6f4ae224f40244990b6a0addffd2124ec95853 diff --git a/docs/submodules/vnfrqts/requirements.git b/docs/submodules/vnfrqts/requirements.git index 7099d63e4..0d5d97e1a 160000 --- a/docs/submodules/vnfrqts/requirements.git +++ b/docs/submodules/vnfrqts/requirements.git @@ -1 +1 @@ -Subproject commit 7099d63e46b0bc9bb5591a5f28e535b95fba2d86 +Subproject commit 0d5d97e1a128ff5a66a8f664c600fbe8b77fc778 diff --git a/docs/submodules/vnfrqts/testcases.git b/docs/submodules/vnfrqts/testcases.git index e4cff9ed8..1248f5ddb 160000 --- a/docs/submodules/vnfrqts/testcases.git +++ b/docs/submodules/vnfrqts/testcases.git @@ -1 +1 @@ -Subproject commit e4cff9ed8bb9f1bd1913f1393963f44f16b734f3 +Subproject commit 1248f5ddbb10f614c20ba85f2a91f3b8caefc11a diff --git a/etc/requirements.txt b/etc/requirements.txt index 8e2894c62..aecf5a3a4 100644 --- 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 index 000000000..0b971f8af --- /dev/null +++ b/shell/smsummary.sh @@ -0,0 +1,27 @@ +#!/bin/bash +# 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 574ff4e39..d98940758 100644 --- a/tox.ini +++ b/tox.ini @@ -6,9 +6,14 @@ skipsdist = true [testenv:docs] deps = -r{toxinidir}/etc/requirements.txt commands = - sphinx-build -j 3 -b html -n -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/html + 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 1 -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 -- 2.16.6