X-Git-Url: https://gerrit.onap.org/r/gitweb?a=blobdiff_plain;f=docs%2Fconf.py;h=41f7e7b181107856a3c436b78ff7ca1bba2d3fa0;hb=9c12311d7715c426a8311b6bcabbd6342c5aa95a;hp=a1c6023bdda78af8b0531eaece356152093e451e;hpb=9fcbadcca35f605cb7b9255034251c24ec31815c;p=policy%2Fparent.git diff --git a/docs/conf.py b/docs/conf.py index a1c6023b..41f7e7b1 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -1,16 +1,106 @@ -from docs_conf.conf import * +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' -master_doc = 'index' -extensions = ['sphinx.ext.autosectionlabel'] -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', + 'sphinx_toolbox.collapse', + '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/' + release + '/main/src/main/resources/openapi/openapi.yaml', + 'opts': { + 'suppress-warnings': True, + 'hide-hostname': True, + } + }, + { + 'name': 'Policy PAP', + 'page': 'pap/local-swagger', + 'spec': 'https://raw.githubusercontent.com/onap/policy-pap/' + release + '/main/src/main/resources/openapi/openapi.yaml', + 'opts': { + 'suppress-warnings': True, + 'hide-hostname': True, + } + }, + { + 'name': 'Policy XACML', + 'page': 'xacml/local-swagger', + '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': { + 'suppress-warnings': True, + 'hide-hostname': True, + } + }, + { + 'name': 'Policy ACM-R', + 'page': 'clamp/acm/api-protocol/local-swagger', + 'spec': 'https://raw.githubusercontent.com/onap/policy-clamp/' + release + '/runtime-acm/src/main/resources/openapi/openapi.yaml', + 'opts': { + 'suppress-warnings': True, + 'hide-hostname': True, + } + }, ] 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_stylesheet("css/ribbon.css") + app.add_css_file("css/ribbon.css") + +linkcheck_ignore = [ + r'http://localhost:\d+/', + r'.(.*?)/local-swagger.html(.*?)' +]