Update KRD docs build 53/64053/3
authorramamani yeleswarapu <ramamani.yeleswarapu@intel.com>
Fri, 31 Aug 2018 17:57:45 +0000 (10:57 -0700)
committerramamani yeleswarapu <ramamani.yeleswarapu@intel.com>
Fri, 31 Aug 2018 20:40:06 +0000 (13:40 -0700)
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

docs/index.rst [new file with mode: 0644]
tox.ini

diff --git a/docs/index.rst b/docs/index.rst
new file mode 100644 (file)
index 0000000..127f0b0
--- /dev/null
@@ -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 1c3bd86..a397103 100644 (file)
--- 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