Fix breaking API documentation generation

Add extension lfdocs-conf and replace ROBOT_VENV with ROBOT3_VENV

Issue-ID: CCSDK-3815
Change-Id: I565ee15bd5862cca0365d153358941b27befb94a
Signed-off-by: halil.cakal <halil.cakal@est.tech>

diff --git a/csit/prepare-csit.sh b/csit/prepare-csit.sh
index 163698d..3e5fa14 100755 (executable)
--- a/csit/prepare-csit.sh
+++ b/csit/prepare-csit.sh
@@ -1,6 +1,6 @@
 #!/bin/bash -x
 #
-# Copyright 2019-2021 © Samsung Electronics Co., Ltd.
+# Copyright 2019-2022 © Samsung Electronics Co., Ltd.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -26,15 +26,15 @@ fi
 
 TESTPLANDIR=${WORKSPACE}/${TESTPLAN}
 
-# Assume that if ROBOT_VENV is set and virtualenv with system site packages can be activated, 
+# Assume that if ROBOT3_VENV is set and virtualenv with system site packages can be activated,
 # ci-management/jjb/integration/include-raw-integration-install-robotframework.sh has already
 # been executed
 
 if [ -f ${WORKSPACE}/env.properties ]; then
     source ${WORKSPACE}/env.properties
 fi
-if [ -f ${ROBOT_VENV}/bin/activate ]; then
-    source ${ROBOT_VENV}/bin/activate
+if [ -f ${ROBOT3_VENV}/bin/activate ]; then
+    source ${ROBOT3_VENV}/bin/activate
 else
     rm -rf /tmp/ci-management
     rm -f ${WORKSPACE}/env.properties
@@ -44,8 +44,8 @@ else
 fi
 
 # install eteutils
-mkdir -p ${ROBOT_VENV}/src/onap
-rm -rf ${ROBOT_VENV}/src/onap/testsuite
+mkdir -p ${ROBOT3_VENV}/src/onap
+rm -rf ${ROBOT3_VENV}/src/onap/testsuite
 pip install --upgrade --extra-index-url="https://nexus3.onap.org/repository/PyPi.staging/simple" 'robotframework-onap==0.5.1.*' --pre
 
 pip freeze

diff --git a/docs/conf.py b/docs/conf.py
index a9c42b6..ee7f207 100644 (file)
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -22,7 +22,9 @@ extensions = [
     'sphinxcontrib.blockdiag',
     'sphinxcontrib.seqdiag',
     'sphinxcontrib.swaggerdoc',
-    'sphinxcontrib.plantuml'
+    'sphinxcontrib.plantuml',
+    'sphinxcontrib.redoc',
+    'sphinx_tabs.tabs'
 ]
 
 #
@@ -32,6 +34,23 @@ extensions = [
 
 branch = 'latest'
 
+redoc = [
+            {
+                'name': 'PMS API',
+                'page': 'offeredapis/pms-api',
+                'spec': './offeredapis/swagger/pms-api.json',
+                'embed': True,
+            },
+            {
+                'name': 'A1 ADAPTER API',
+                'page': 'offeredapis/a1-adapter-api',
+                'spec': './offeredapis/swagger/a1-adapter-api.json',
+                'embed': True,
+            }
+        ]
+
+redoc_uri = 'https://cdn.jsdelivr.net/npm/redoc@next/bundles/redoc.standalone.js'
+
 intersphinx_mapping = {}
 doc_url = 'https://docs.onap.org/projects'
 master_doc = 'index'

diff --git a/docs/requirements-docs.txt b/docs/requirements-docs.txt
index 71df2ab..009b997 100644 (file)
--- a/docs/requirements-docs.txt
+++ b/docs/requirements-docs.txt
@@ -1,3 +1,4 @@
+lfdocs-conf
 sphinx>=4.2.0  # BSD
 sphinx-rtd-theme>=1.0.0  # MIT
 sphinxcontrib-blockdiag  # BSD
@@ -5,3 +6,4 @@ sphinxcontrib-seqdiag # BSD
 sphinxcontrib-swaggerdoc
 sphinxcontrib-spelling
 sphinxcontrib-plantuml
+sphinxcontrib-redoc