From: ramamani yeleswarapu <ramamani.yeleswarapu@intel.com>
Date: Fri, 31 Aug 2018 17:57:45 +0000 (-0700)
Subject: Update KRD docs build
X-Git-Tag: 3.0.0-ONAP~62
X-Git-Url: https://gerrit.onap.org/r/gitweb?a=commitdiff_plain;h=refs%2Fchanges%2F53%2F64053%2F3;p=multicloud%2Fk8s.git

Update KRD docs build

This adds docs/index.rst with links to:
  - krd_architecture.rst and
  - sampleCommands.rst.

It is now possible to generate documentation using 'tox -e docs'.

Change-Id: I176a01943d36659101b3251a8756866459d5491f
Signed-off-by: ramamani yeleswarapu <ramamani.yeleswarapu@intel.com>
Issue-ID: MULTICLOUD-301
---

diff --git a/docs/index.rst b/docs/index.rst
new file mode 100644
index 00000000..127f0b0e
--- /dev/null
+++ b/docs/index.rst
@@ -0,0 +1,22 @@
+MultiCloud Kubernetes Plugin
+============================
+
+This plugin is a part of the MultiCloud component in ONAP.
+It will allow ONAP to deploy/manage VM and container based VNFs
+over cloud regions that support Kubernetes as the orchestrator.
+
+Kubernetes Reference Deployment
+===============================
+
+The Kubernetes Reference Deployment(KRD) provides an
+automated mechanism to install and configure the Kubernetes
+services required for the MultiCloud Kubernetes plugin.
+
+Table of contents
+-----------------
+
+.. toctree::
+   :maxdepth: 3
+
+   Project Architecture <krd_architecture>
+   Sample Commands <sampleCommands>
diff --git a/tox.ini b/tox.ini
index 1c3bd862..a3971037 100644
--- a/tox.ini
+++ b/tox.ini
@@ -22,4 +22,4 @@ commands = bash -c "find {toxinidir} -not -path {toxinidir}/.tox/\* \
 
 [testenv:docs]
 deps = sphinx
-commands = sphinx-build -W -b html docs/src docs/build/html
+commands = sphinx-build -W -b html docs docs/build/html