[AAI] Fix doc config fileskohn

Issue-ID: AAI-3572
Signed-off-by: wr148d <wr148d@att.com>
Change-Id: Ieb00798efc40869710e830f464aed96ee85d2af2

7 files changed, 82 insertions, 32 deletions

diff --git a/.readthedocs.yaml b/.readthedocs.yaml
index 3797dc8..dc0c78b 100644
--- a/.readthedocs.yaml
+++ b/.readthedocs.yaml
@@ -1,13 +1,11 @@
 ---
 # .readthedocs.yml
-# Read the Docs configuration file
-# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
-# Required
+# # Read the Docs configuration file
+# # See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+# # Required
+#
 version: 2
 
-formats:
-  - htmlzip
-
 build:
   image: latest
 
@@ -16,5 +14,8 @@ python:
   install:
     - requirements: docs/requirements-docs.txt
 
+submodules:
+  include: all
+
 sphinx:
   configuration: docs/conf.py
diff --git a/docs/_static/css/ribbon.css b/docs/_static/css/ribbon.css
index 6008cb1..afb9480 100644
--- a/docs/_static/css/ribbon.css
+++ b/docs/_static/css/ribbon.css
@@ -59,5 +59,5 @@
 /* fix width of the screen */
 
 .wy-nav-content {
-    max-width: none;
+    max-width: 800px;
 }
diff --git a/docs/conf.py b/docs/conf.py
index a703bc9..892fc98 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -1,17 +1,56 @@
-from docs_conf.conf import *
-
-branch = 'latest'
-master_doc = 'index'
+project = "onap"
 release = "kohn"
 version = "kohn"
 
-linkcheck_ignore = [
-    'http://localhost',
+author = "Open Network Automation Platform"
+# yamllint disable-line rule:line-length
+copyright = "ONAP. Licensed under Creative Commons Attribution 4.0 International License"
+
+pygments_style = "sphinx"
+html_theme = "sphinx_rtd_theme"
+html_theme_options = {
+  "style_nav_header_background": "white",
+  "sticky_navigation": "False" }
+html_logo = "_static/logo_onap_2017.png"
+html_favicon = "_static/favicon.ico"
+html_static_path = ["_static"]
+html_show_sphinx = False
+
+extensions = [
+    'sphinx.ext.intersphinx',
+    'sphinx.ext.graphviz',
+    'sphinxcontrib.blockdiag',
+    'sphinxcontrib.seqdiag',
+    'sphinxcontrib.swaggerdoc',
+    'sphinxcontrib.plantuml'
 ]
 
+#
+# Map to 'latest' if this file is used in 'latest' (master) 'doc' branch.
+# Change to {releasename} after you have created the new 'doc' branch.
+#
+
+branch = 'latest'
+
 intersphinx_mapping = {}
+doc_url = 'https://docs.onap.org/projects'
+master_doc = 'index'
+
+exclude_patterns = ['.tox']
+
+spelling_word_list_filename='spelling_wordlist.txt'
+spelling_lang = "en_GB"
+
+#
+# Example:
+# intersphinx_mapping['onap-aai-aai-common'] = ('{}/onap-aai-aai-common/en/%s'.format(doc_url) % branch, None)
+#
 
 html_last_updated_fmt = '%d-%b-%y %H:%M'
 
 def setup(app):
     app.add_css_file("css/ribbon.css")
+
+linkcheck_ignore = [
+  r'http://localhost:\d+/'
+]
\ No newline at end of file
diff --git a/docs/index.rst b/docs/index.rst
index 2d010a2..0580a9e 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -15,7 +15,7 @@ Sparky - Inventory UI Service
 
 Overview
 ========
-Sparky is a service that interacts with resources and traversal microservices, and provides users with a user interface to view and analyze A&AI data. The main goal behind Sparky is to provide a clear and user friendly view of A&AI data.
+Sparky is a service that interacts with resources and traversal microservices, and provides users with a user interface to view and analyze AAI data. The main goal behind Sparky is to provide a clear and user friendly view of AAI data.
 
 The key AAI repos for running the Sparky UI are:
 
diff --git a/docs/platform/specialized.rst b/docs/platform/specialized.rst
index 2baa6d5..7a9c642 100644
--- a/docs/platform/specialized.rst
+++ b/docs/platform/specialized.rst
@@ -1,10 +1,10 @@
 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
 
 Sparky - Specialized Search
-=======================
+===========================
 
 *Specialized Search* Overview
-~~~~~~~~~~~~~~~~~~~~~~~~~
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 *Specialized Search* provides a way to easily filter the inventory items in A&AI
 
@@ -14,7 +14,7 @@ Sparky - Specialized Search
    :align: center
 
 *Specialized Search* Features
-~~~~~~~~~~~~~~~~~~~~~~~~~
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 With Specialized Search UI, users can:
   * Click on a radio button for a configured node-type and add filters to run and view instance data
   * The user can view the information on the subsequent page in a paginated format (50 results per page)
@@ -28,7 +28,7 @@ With Specialized Search UI, users can:
   * The user can build a query giving the element and all related elements (1 hop) by clicking >>BYOQ
 
 Navigation to *Specialized Search*
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 The *Specialized Search* view can be reached by clicking on the hamburger menu item Specialized Search
 
@@ -38,7 +38,7 @@ The *Specialized Search* view can be reached by clicking on the hamburger menu i
    :align: center
 
 How to use *Specialized Search*
-~~~~~~~~~~~~~~~~~~~~~~~~~~~
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 1. On Specialized Search a user can select an element type
 
 .. image:: images/specialized-search-1.JPG
diff --git a/docs/requirements-docs.txt b/docs/requirements-docs.txt
index 3b3441a..71df2ab 100644
--- a/docs/requirements-docs.txt
+++ b/docs/requirements-docs.txt
@@ -1,3 +1,7 @@
-lfdocs-conf
 sphinx>=4.2.0  # BSD
 sphinx-rtd-theme>=1.0.0  # MIT
+sphinxcontrib-blockdiag  # BSD
+sphinxcontrib-seqdiag # BSD
+sphinxcontrib-swaggerdoc
+sphinxcontrib-spelling
+sphinxcontrib-plantuml
diff --git a/docs/tox.ini b/docs/tox.ini
index 49bbe01..4a8d9a0 100644
--- a/docs/tox.ini
+++ b/docs/tox.ini
@@ -1,6 +1,6 @@
 [tox]
 minversion = 1.6
-envlist = docs,
+envlist = docs,docs-linkcheck,docs-spellcheck
 skipsdist = true
 
 [testenv:docs]
@@ -8,18 +8,24 @@ basepython = python3.8
 deps =
     -r{toxinidir}/requirements-docs.txt
     -chttps://raw.githubusercontent.com/openstack/requirements/stable/yoga/upper-constraints.txt
-    -chttps://git.onap.org/doc/plain/etc/upper-constraints.onap.txt
+    -chttps://git.onap.org/doc/plain/etc/upper-constraints.onap.txt?h=kohn
 commands =
-    sphinx-build -b html -n -d {envtmpdir}/doctrees ./ {toxinidir}/_build/html
-    echo "Generated docs available in {toxinidir}/_build/html"
-whitelist_externals =
-    echo
-    git
-    sh
+    sphinx-build -W -q -b html -n -d {envtmpdir}/doctrees {toxinidir} {toxinidir}/_build/html
 
 [testenv:docs-linkcheck]
 basepython = python3.8
-#deps = -r{toxinidir}/requirements-docs.txt
-commands = echo "Link Checking not enforced"
-#commands = sphinx-build -b linkcheck -d {envtmpdir}/doctrees ./ {toxinidir}/_build/linkcheck
-whitelist_externals = echo
+deps =
+    -r{toxinidir}/requirements-docs.txt
+    -chttps://raw.githubusercontent.com/openstack/requirements/stable/yoga/upper-constraints.txt
+    -chttps://git.onap.org/doc/plain/etc/upper-constraints.onap.txt?h=kohn
+commands =
+    sphinx-build -W -q -b linkcheck -d {envtmpdir}/doctrees {toxinidir} {toxinidir}/_build/linkcheck
+
+[testenv:docs-spellcheck]
+basepython = python3.8
+deps =
+    -r{toxinidir}/requirements-docs.txt
+    -chttps://raw.githubusercontent.com/openstack/requirements/stable/yoga/upper-constraints.txt
+    -chttps://git.onap.org/doc/plain/etc/upper-constraints.onap.txt?h=kohn
+commands =
+    sphinx-build -W -q -b spelling -d {envtmpdir}/doctrees {toxinidir} {toxinidir}/_build/spellcheck