Merge "Release Note in Casablanca"

diff --git a/.gitignore b/.gitignore
index a5beebe..06b9462 100644 (file)
--- a/.gitignore
+++ b/.gitignore
@@ -13,3 +13,6 @@ multivimbroker/.coverage
 multivimbroker/.tox/
 multivimbroker/logs/*.log
 multivimbroker/test-reports/
+
+# Docs related
+docs/html

diff --git a/docs/conf.py b/docs/conf.py
new file mode 100644 (file)
index 0000000..bab9649
--- /dev/null
+++ b/docs/conf.py
@@ -0,0 +1,40 @@
+# -*- coding: utf-8 -*-
+# 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.
+
+import os
+import sys
+
+BASE_DIR = os.path.dirname(os.path.abspath(__file__))
+ROOT = os.path.abspath(os.path.join(BASE_DIR, "..", ".."))
+
+sys.path.insert(0, ROOT)
+sys.path.insert(0, BASE_DIR)
+
+# -- General configuration ----------------------------------------------------
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
+extensions = [
+    'sphinx.ext.autodoc',
+    #'sphinx.ext.intersphinx'
+]
+
+# The suffix of source filenames.
+source_suffix = '.rst'
+
+# The master toctree document.
+master_doc = 'index'
+
+# General information about the project.
+project = u'MultiCloud Framework'

diff --git a/docs/multicloud-plugin-vio/Multicloud-Fake_Cloud-Guide.rst b/docs/multicloud-plugin-vio/Multicloud-Fake_Cloud-Guide.rst
index c0e2f03..0b78a3d 100644 (file)
--- a/docs/multicloud-plugin-vio/Multicloud-Fake_Cloud-Guide.rst
+++ b/docs/multicloud-plugin-vio/Multicloud-Fake_Cloud-Guide.rst
@@ -2,9 +2,9 @@
  This work is licensed under a Creative Commons Attribution 4.0
  International License.
 
-===================================================
+
 MultiCloud VMware OpenStack Simulated API User Case
-===================================================
+---------------------------------------------------
 
 When there's no real VIO environment at hands, we could still use fake_cloud APIs
 in VIO plugin to test ONAP functions. These set of APIs simulate the real VIO functions

diff --git a/multivimbroker/tox.ini b/multivimbroker/tox.ini
index af3b3a5..1e54370 100644 (file)
--- a/multivimbroker/tox.ini
+++ b/multivimbroker/tox.ini
@@ -32,3 +32,7 @@ deps = rstcheck
 whitelist_externals = bash
 commands = bash -c "find ../docs -not -path {toxinidir}/.tox/\* \
    -name \*.rst -type f -print0 | xargs -0 rstcheck --report warning"
+
+[testenv:docs]
+deps = sphinx
+commands = sphinx-build -b html ../docs/ ../docs/html