DOCS: Update the Documentation.

This patch updates the documentation for Jerma.

Signed-off-by: Sridhar K. N. Rao <sridhar.rao@spirent.com>
Change-Id: Ic0d61a74b1c8d31c8facaa16837894fc816ac739

21 files changed, 49 insertions, 59 deletions

diff --git a/docs/index.rst b/docs/index.rst
index 08fb3bd..5c7f35b 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -12,6 +12,10 @@ OPNFV CIRV-SDV
    :maxdepth: 3
 
    release/release-notes/index
-   release/userguide/results/index
-   release/configguide/index
-   development/index
+   pdf/userguide
+   sdvconfig/developer/devguide
+   sdvconfig/user/configguide
+   sdvconfig/user/userguide
+   state/development/design/index
+   state/development/overview/settings
+   state/development/overview/result_api
diff --git a/docs/release/userguide/pdf/user/userguide.rst b/docs/pdf/userguide.rst
index 2394888..2394888 100644
--- a/docs/release/userguide/pdf/user/userguide.rst
+++ b/docs/pdf/userguide.rst
diff --git a/docs/release/configguide/index.rst b/docs/release/configguide/index.rst
deleted file mode 100644
index 73ef396..0000000
--- a/docs/release/configguide/index.rst
+++ /dev/null
@@ -1,6 +0,0 @@
-.. This work is licensed under a Creative Commons Attribution 4.0 International License.
-.. http://creativecommons.org/licenses/by/4.0
-.. (c) OPNFV, Spirent Communications, University of Delhi and others.
-
-CIRV-SDV Configuration Guide
-============================
diff --git a/docs/release/release-notes/release-notes.rst b/docs/release/release-notes/release-notes.rst
index 1257fb5..97b28db 100644
--- a/docs/release/release-notes/release-notes.rst
+++ b/docs/release/release-notes/release-notes.rst
@@ -2,11 +2,17 @@
 .. http://creativecommons.org/licenses/by/4.0
 .. (c) OPNFV, Spirent Communications, University of Delhi and others. 
 
-OPNFV Jerma Release
-====================
+OPNFV CIRV-SDV Jerma Release
+============================
 
-* Platform Definition File Templates and Tools.
-* Resource Modelling.
-* Pre-Deployment Validation
-* Post-Deployment Validation
+Platform Definition file
 
+  * Version-1 Template 
+  * GUI Tool to create PDF.
+
+Tools:
+
+  * Resource Modelling.
+  * URL Validation - Airship.
+  * Pre-Deployment Validation: Airship v1.7.
+  * Post-Deployment Validation: Airship v1.7
diff --git a/docs/release/userguide/docker/state/release/configguide/index.rst b/docs/release/userguide/docker/state/release/configguide/index.rst
deleted file mode 100644
index e69de29..0000000
--- a/docs/release/userguide/docker/state/release/configguide/index.rst
+++ /dev/null
diff --git a/docs/release/userguide/docker/state/release/userguide/index.rst b/docs/release/userguide/docker/state/release/userguide/index.rst
deleted file mode 100644
index e69de29..0000000
--- a/docs/release/userguide/docker/state/release/userguide/index.rst
+++ /dev/null
diff --git a/docs/release/userguide/index.rst b/docs/release/userguide/index.rst
deleted file mode 100644
index 6e36402..0000000
--- a/docs/release/userguide/index.rst
+++ /dev/null
@@ -1,6 +0,0 @@
-.. This work is licensed under a Creative Commons Attribution 4.0 International License.
-.. http://creativecommons.org/licenses/by/4.0
-.. (c) OPNFV, Spirent Communications, University of Delhi and others.
-
-CIRV-SDV User Guide
-===================
diff --git a/docs/release/userguide/docker/sdvconfig/developer/devguide.rst b/docs/sdvconfig/developer/devguide.rst
index 7c1fc15..ec61c46 100644
--- a/docs/release/userguide/docker/sdvconfig/developer/devguide.rst
+++ b/docs/sdvconfig/developer/devguide.rst
@@ -1,14 +1,14 @@
-=========
-SDVConfig
-=========
+=========================
+SDVConfig Developer Guide
+=========================
 Welcome to the SDVConfig Developer Guide!
 
 Who should use this guide?
 
 If you want to extend SDVConfig by using a creating a module, adding functionality to an existing module, or expanding test coverage, this guide is for you. We’ve included detailed information for developers on how to test and document modules, as well as the prerequisites for getting your module be accepted into the main SDV repository.
 
-Table of Contents
-^^^^^^^^^^^^^^^^^
+Contents
+^^^^^^^^
 - Description of the project
 - Software architecture of the project
 - Software technologies uses
@@ -306,4 +306,4 @@ and the core recursive code which is used to find keys in the manifest files is
                         return True
         return False
 
-The code first iterates through all the profiles, and for each profile it checks with each key, gets its corresponding mapped value from the mapping files and checks whether the key exists in the installer manifest or not.
\ No newline at end of file
+The code first iterates through all the profiles, and for each profile it checks with each key, gets its corresponding mapped value from the mapping files and checks whether the key exists in the installer manifest or not.
diff --git a/docs/release/userguide/docker/sdvconfig/developer/extrapolation-flow.png b/docs/sdvconfig/developer/extrapolation-flow.png
index 5b220af..5b220af 100644
--- a/docs/release/userguide/docker/sdvconfig/developer/extrapolation-flow.png
+++ b/docs/sdvconfig/developer/extrapolation-flow.png
diff --git a/docs/release/userguide/docker/sdvconfig/developer/extrapolation.png b/docs/sdvconfig/developer/extrapolation.png
index 1a0f777..1a0f777 100644
--- a/docs/release/userguide/docker/sdvconfig/developer/extrapolation.png
+++ b/docs/sdvconfig/developer/extrapolation.png
diff --git a/docs/release/userguide/docker/sdvconfig/developer/validation-flow.png b/docs/sdvconfig/developer/validation-flow.png
index de4853e..de4853e 100644
--- a/docs/release/userguide/docker/sdvconfig/developer/validation-flow.png
+++ b/docs/sdvconfig/developer/validation-flow.png
diff --git a/docs/release/userguide/docker/sdvconfig/developer/validation.png b/docs/sdvconfig/developer/validation.png
index f6d2dc3..f6d2dc3 100644
--- a/docs/release/userguide/docker/sdvconfig/developer/validation.png
+++ b/docs/sdvconfig/developer/validation.png
diff --git a/docs/release/userguide/docker/sdvconfig/user/configguide.rst b/docs/sdvconfig/user/configguide.rst
index d8bb3c2..424f08c 100644
--- a/docs/release/userguide/docker/sdvconfig/user/configguide.rst
+++ b/docs/sdvconfig/user/configguide.rst
@@ -1,6 +1,6 @@
-=========
-SDVConfig
-=========
+======================
+SDVConfig Config Guide
+======================
 Welcome to the SDVConfig config Guide!
 
 Who should use this guide?
diff --git a/docs/release/userguide/docker/sdvconfig/user/userguide.rst b/docs/sdvconfig/user/userguide.rst
index f38303d..917ea8d 100644
--- a/docs/release/userguide/docker/sdvconfig/user/userguide.rst
+++ b/docs/sdvconfig/user/userguide.rst
@@ -1,6 +1,6 @@
-=========
-SDVConfig
-=========
+====================
+SDVConfig User Guide
+====================
 Welcome to the SDVConfig user Guide!
 
 Who should use this guide?
diff --git a/docs/release/userguide/docker/state/development/design/index.rst b/docs/state/development/design/index.rst
index e69de29..e69de29 100644
--- a/docs/release/userguide/docker/state/development/design/index.rst
+++ b/docs/state/development/design/index.rst
diff --git a/docs/release/userguide/docker/state/development/overview/index.rst b/docs/state/development/overview/index.rst
index e69de29..e69de29 100644
--- a/docs/release/userguide/docker/state/development/overview/index.rst
+++ b/docs/state/development/overview/index.rst
diff --git a/docs/release/userguide/docker/state/development/overview/result-api-architecture.png b/docs/state/development/overview/result-api-architecture.png
index e464187..e464187 100644
--- a/docs/release/userguide/docker/state/development/overview/result-api-architecture.png
+++ b/docs/state/development/overview/result-api-architecture.png
diff --git a/docs/release/userguide/docker/state/development/overview/result_api.rst b/docs/state/development/overview/result_api.rst
index 12fd62c..6412c7d 100644
--- a/docs/release/userguide/docker/state/development/overview/result_api.rst
+++ b/docs/state/development/overview/result_api.rst
@@ -1,5 +1,5 @@
-Result API
-==========
+SDVState: Result API
+====================
 
 Table of contents
 ^^^^^^^^^^^^^^^^^
diff --git a/docs/release/userguide/docker/state/development/overview/settings.rst b/docs/state/development/overview/settings.rst
index c70f21e..29068c5 100644
--- a/docs/release/userguide/docker/state/development/overview/settings.rst
+++ b/docs/state/development/overview/settings.rst
@@ -1,5 +1,5 @@
-Program Settings handler
-------------------------
+SDVState: Program Settings handler
+----------------------------------
 
 ``from tools.conf import settings``
 
@@ -35,4 +35,4 @@ same.
 all it’s sub-directory recursively in ascending order, hence if a
 configuration item exists in more than one file, then the setting in the
 file that occurs in the last read file will have high precedence and
-overwrite previous values. .
\ No newline at end of file
+overwrite previous values. .
diff --git a/docs/release/userguide/docker/urls/userguide.rst b/docs/urls/userguide.rst
index 15d0724..15d0724 100644
--- a/docs/release/userguide/docker/urls/userguide.rst
+++ b/docs/urls/userguide.rst
diff --git a/tox.ini b/tox.ini
index 5fafde1..069297a 100644
--- a/tox.ini
+++ b/tox.ini
@@ -1,25 +1,17 @@
 [tox]
-envlist = pep8,yamllint,pylint
+minversion = 1.6
+envlist = 
+    docs,
+    docs-linkcheck
+skipsdist = true
 
-[testenv]
-deps =
-  -c{env:UPPER_CONSTRAINTS_FILE:https://opendev.org/openstack/requirements/raw/branch/master/upper-constraints.txt}
-  -r{toxinidir}/requirements.txt
-  -r{toxinidir}/test-requirements.txt
-
-[testenv:pep8]
-basepython = python3
-commands = flake8
-
-[testenv:yamllint]
-basepython = python3
-files =
-  INFO.yaml
-  sdv
+[testenv:docs]
+deps = -rdocs/requirements.txt
 commands =
-  yamllint -s {[testenv:yamllint]files} -c {toxinidir}/yamllintrc
+    sphinx-build -b html -n -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/html
+    echo "Generated docs available in {toxinidir}/docs/_build/html"
+whitelist_externals = echo
 
-[testenv:pylint]
-basepython = python3
-commands =
-  pylint sdv
+[testenv:docs-linkcheck]
+deps = -rdocs/requirements.txt
+commands = sphinx-build -b linkcheck -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/linkcheck