docs/conf.py

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