Add documentation of participant composition properties

[policy/parent.git] / docs / conf.py

diff --git a/docs/conf.py b/docs/conf.py
index 3e04bef..41f7e7b 100644 (file)
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -2,6 +2,10 @@ project = "onap"
 release = "master"
 version = "master"
 
+# 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'
+
 author = "Open Network Automation Platform"
 # yamllint disable-line rule:line-length
 copyright = "ONAP. Licensed under Creative Commons Attribution 4.0 International License"
@@ -27,13 +31,14 @@ extensions = [
     'sphinxcontrib.redoc'
 ]
 
+redoc_uri = 'https://cdn.redoc.ly/redoc/latest/bundles/redoc.standalone.js'
+
 redoc = [
     {
         'name': 'Policy API',
         'page': 'api/local-swagger',
-        'spec': 'https://raw.githubusercontent.com/onap/policy-api/master/main/src/main/resources/openapi/openapi.yaml',
+        'spec': 'https://raw.githubusercontent.com/onap/policy-api/' + release + '/main/src/main/resources/openapi/openapi.yaml',
         'opts': {
-            'lazy-rendering': True,
             'suppress-warnings': True,
             'hide-hostname': True,
         }
@@ -41,9 +46,8 @@ redoc = [
     {
         'name': 'Policy PAP',
         'page': 'pap/local-swagger',
-        'spec': 'https://raw.githubusercontent.com/onap/policy-pap/master/main/src/main/resources/openapi/openapi.yaml',
+        'spec': 'https://raw.githubusercontent.com/onap/policy-pap/' + release + '/main/src/main/resources/openapi/openapi.yaml',
         'opts': {
-            'lazy-rendering': False,
             'suppress-warnings': True,
             'hide-hostname': True,
         }
@@ -51,9 +55,17 @@ redoc = [
     {
         'name': 'Policy XACML',
         'page': 'xacml/local-swagger',
-        'spec': 'https://raw.githubusercontent.com/onap/policy-xacml-pdp/master/main/src/main/resources/openapi/openapi.yaml',
+        'spec': 'https://raw.githubusercontent.com/onap/policy-xacml-pdp/' + release + '/main/src/main/resources/openapi/openapi.yaml',
+        'opts': {
+            'suppress-warnings': True,
+            'hide-hostname': True,
+        }
+    },
+    {
+        'name': 'Policy DROOLS',
+        'page': 'drools/local-swagger',
+        'spec': 'https://raw.githubusercontent.com/onap/policy-drools-pdp/' + release + '/feature-healthcheck/src/main/resources/openapi/openapi.yaml',
         'opts': {
-            'lazy-rendering': False,
             'suppress-warnings': True,
             'hide-hostname': True,
         }
@@ -61,22 +73,14 @@ redoc = [
     {
         'name': 'Policy ACM-R',
         'page': 'clamp/acm/api-protocol/local-swagger',
-        'spec': 'https://raw.githubusercontent.com/onap/policy-clamp/master/runtime-acm/src/main/resources/openapi/openapi.yaml',
+        'spec': 'https://raw.githubusercontent.com/onap/policy-clamp/' + release + '/runtime-acm/src/main/resources/openapi/openapi.yaml',
         'opts': {
-            'lazy-rendering': False,
             'suppress-warnings': True,
             'hide-hostname': True,
         }
     },
 ]
 
-#
-# 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'
@@ -98,5 +102,5 @@ def setup(app):
 
 linkcheck_ignore = [
   r'http://localhost:\d+/',
-  r'./local-swagger.html(.*?)'
+  r'.(.*?)/local-swagger.html(.*?)'
 ]