docs/conf.py

   1 project = "onap"
   2 release = "master"
   3 version = "master"
   4
   5 # Map to 'latest' if this file is used in 'latest' (master) 'doc' branch.
   6 # Change to {releasename} after you have created the new 'doc' branch.
   7 branch = 'latest'
   8
   9 author = "Open Network Automation Platform"
  10 # yamllint disable-line rule:line-length
  11 copyright = "ONAP. Licensed under Creative Commons Attribution 4.0 International License"
  12
  13 pygments_style = "sphinx"
  14 html_theme = "sphinx_rtd_theme"
  15 html_theme_options = {
  16   "style_nav_header_background": "white",
  17   "sticky_navigation": "False" }
  18 html_logo = "_static/logo_onap_2017.png"
  19 html_favicon = "_static/favicon.ico"
  20 html_static_path = ["_static"]
  21 html_show_sphinx = False
  22
  23 extensions = [
  24     'sphinx.ext.intersphinx',
  25     'sphinx.ext.graphviz',
  26     'sphinxcontrib.blockdiag',
  27     'sphinxcontrib.seqdiag',
  28     'sphinxcontrib.swaggerdoc',
  29     'sphinxcontrib.plantuml',
  30     'sphinx_toolbox.collapse',
  31     'sphinxcontrib.redoc'
  32 ]
  33
  34 redoc_uri = 'https://cdn.redoc.ly/redoc/latest/bundles/redoc.standalone.js'
  35
  36 redoc = [
  37     {
  38         'name': 'Policy API',
  39         'page': 'api/local-swagger',
  40         'spec': 'https://raw.githubusercontent.com/onap/policy-api/' + release + '/main/src/main/resources/openapi/openapi.yaml',
  41         'opts': {
  42             'suppress-warnings': True,
  43             'hide-hostname': True,
  44         }
  45     },
  46     {
  47         'name': 'Policy PAP',
  48         'page': 'pap/local-swagger',
  49         'spec': 'https://raw.githubusercontent.com/onap/policy-pap/' + release + '/main/src/main/resources/openapi/openapi.yaml',
  50         'opts': {
  51             'suppress-warnings': True,
  52             'hide-hostname': True,
  53         }
  54     },
  55     {
  56         'name': 'Policy XACML',
  57         'page': 'xacml/local-swagger',
  58         'spec': 'https://raw.githubusercontent.com/onap/policy-xacml-pdp/' + release + '/main/src/main/resources/openapi/openapi.yaml',
  59         'opts': {
  60             'suppress-warnings': True,
  61             'hide-hostname': True,
  62         }
  63     },
  64     {
  65         'name': 'Policy DROOLS',
  66         'page': 'drools/local-swagger',
  67         'spec': 'https://raw.githubusercontent.com/onap/policy-drools-pdp/' + release + '/feature-healthcheck/src/main/resources/openapi/openapi.yaml',
  68         'opts': {
  69             'suppress-warnings': True,
  70             'hide-hostname': True,
  71         }
  72     },
  73     {
  74         'name': 'Policy ACM-R',
  75         'page': 'clamp/acm/api-protocol/local-swagger',
  76         'spec': 'https://raw.githubusercontent.com/onap/policy-clamp/' + release + '/runtime-acm/src/main/resources/openapi/openapi.yaml',
  77         'opts': {
  78             'suppress-warnings': True,
  79             'hide-hostname': True,
  80         }
  81     },
  82 ]
  83
  84 intersphinx_mapping = {}
  85 doc_url = 'https://docs.onap.org/projects'
  86 master_doc = 'index'
  87
  88 exclude_patterns = ['.tox']
  89
  90 spelling_word_list_filename='spelling_wordlist.txt'
  91 spelling_lang = "en_GB"
  92
  93 #
  94 # Example:
  95 # intersphinx_mapping['onap-aai-aai-common'] = ('{}/onap-aai-aai-common/en/%s'.format(doc_url) % branch, None)
  96 #
  97
  98 html_last_updated_fmt = '%d-%b-%y %H:%M'
  99
 100 def setup(app):
 101     app.add_css_file("css/ribbon.css")
 102
 103 linkcheck_ignore = [
 104   r'http://localhost:\d+/',
 105   r'.(.*?)/local-swagger.html(.*?)'
 106 ]