summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
-rw-r--r--docs/conf.py4
-rw-r--r--docs/index.rst12
-rw-r--r--docs/release/index.rst18
-rw-r--r--docs/smsummary.rst10
m---------docs/submodules/aai/event-client.git0
m---------docs/submodules/aai/sparky-be.git0
m---------docs/submodules/ccsdk/distribution.git0
m---------docs/submodules/ccsdk/parent.git0
m---------docs/submodules/ccsdk/platform/plugins.git0
m---------docs/submodules/dmaap/messagerouter/messageservice.git0
m---------docs/submodules/logging-analytics.git0
m---------docs/submodules/music.git0
m---------docs/submodules/optf/has.git0
m---------docs/submodules/optf/osdf.git0
m---------docs/submodules/so/libs.git0
m---------docs/submodules/vnfrqts/requirements.git0
m---------docs/submodules/vnfrqts/testcases.git0
-rw-r--r--etc/requirements.txt2
-rw-r--r--shell/smsummary.sh27
-rw-r--r--tox.ini9
20 files changed, 59 insertions, 23 deletions
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) <installing-onap-k8s>`. Recommended method.
+* :ref:`Installation using Kubernetes (aka OOM) <installing-onap-k8s>`.
+ Recommended method.
* :ref:`Installation using Heat template <installing-onap-heat>`.
-* :ref:`Advanced installation to install individual components <installing-onap-individual>`.
+* :ref:`Advanced installation to install individual components
+ <installing-onap-individual>`.
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
-Subproject 14eddc2cc36b4c64782c7b1ea7a1abd6be1c2f2
+Subproject 0e52f7e4939820808d7c849aaf64cfbbd187f7e
diff --git a/docs/submodules/aai/sparky-be.git b/docs/submodules/aai/sparky-be.git
-Subproject 30643d72ec44dddb06a17d5ad29b0c45e90a445
+Subproject 847b9d464fe26ac3bca915cbda65bc0e55b6167
diff --git a/docs/submodules/ccsdk/distribution.git b/docs/submodules/ccsdk/distribution.git
-Subproject 424327075cba872296535ffbfe69f32c228b218
+Subproject 7e9bf97e8ae8dd7a4da324af175c7969fa0f9c2
diff --git a/docs/submodules/ccsdk/parent.git b/docs/submodules/ccsdk/parent.git
-Subproject 5e50437a127d861e044a4d25e55ac63585ccc6b
+Subproject efca2079cd4dc3e7cd09a077db0c79c61d05565
diff --git a/docs/submodules/ccsdk/platform/plugins.git b/docs/submodules/ccsdk/platform/plugins.git
-Subproject ac39f88aa15b511dab1230720057b9737d38c10
+Subproject 5cb7beb34ee10ef1a7c8363b9dd8fc3016151c6
diff --git a/docs/submodules/dmaap/messagerouter/messageservice.git b/docs/submodules/dmaap/messagerouter/messageservice.git
-Subproject 9072eeb0cff6005902d0d21b3e5653e28428812
+Subproject f3f0a2c774047136c8f580ad811c2e60f6218ea
diff --git a/docs/submodules/logging-analytics.git b/docs/submodules/logging-analytics.git
-Subproject 60de689fa4c16807d69646f5604d7ed1042f1dc
+Subproject 236edd3c4665ffce1bcd832c5cf73739e77e77c
diff --git a/docs/submodules/music.git b/docs/submodules/music.git
-Subproject 98e3809b59399dbe8174d97cdf3367beb475e53
+Subproject 287bdcbb5482f94df091c3b7b766fed0007efa2
diff --git a/docs/submodules/optf/has.git b/docs/submodules/optf/has.git
-Subproject ed7c491c37db044b07ab97781a2d8cab63bcfe9
+Subproject 633927402f317714069ae71e0ee766a0d54194e
diff --git a/docs/submodules/optf/osdf.git b/docs/submodules/optf/osdf.git
-Subproject 99be035a26a198d676547c9f88c56f1f0c37b69
+Subproject b05fb22d90def79369e37f4e08ae19595317421
diff --git a/docs/submodules/so/libs.git b/docs/submodules/so/libs.git
-Subproject d184b2b864673755acec7acdf35f7687b1b13de
+Subproject bd6f4ae224f40244990b6a0addffd2124ec9585
diff --git a/docs/submodules/vnfrqts/requirements.git b/docs/submodules/vnfrqts/requirements.git
-Subproject 7099d63e46b0bc9bb5591a5f28e535b95fba2d8
+Subproject 0d5d97e1a128ff5a66a8f664c600fbe8b77fc77
diff --git a/docs/submodules/vnfrqts/testcases.git b/docs/submodules/vnfrqts/testcases.git
-Subproject e4cff9ed8bb9f1bd1913f1393963f44f16b734f
+Subproject 1248f5ddbb10f614c20ba85f2a91f3b8caefc11
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