From 2f0b896a56c6297ce3434c8d5279b3440e437f18 Mon Sep 17 00:00:00 2001 From: ramamani yeleswarapu Date: Fri, 31 Aug 2018 10:57:45 -0700 Subject: 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 Issue-ID: MULTICLOUD-301 --- docs/index.rst | 22 ++++++++++++++++++++++ tox.ini | 2 +- 2 files changed, 23 insertions(+), 1 deletion(-) create mode 100644 docs/index.rst 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 + Sample Commands 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 -- cgit 1.2.3-korg