X-Git-Url: https://gerrit.onap.org/r/gitweb?a=blobdiff_plain;f=docs%2Fconf.py;h=367166bf2168da5ee557d0eda75e5838f848ddac;hb=fa9ddbfc8ae98ac96b69847c42302e4a384c63f6;hp=87611ec929af91492090023fa29bb9258ff37fe4;hpb=961360a3abe73d22f3a97c5e8b3ecbb185a646cf;p=policy%2Fparent.git diff --git a/docs/conf.py b/docs/conf.py index 87611ec9..367166bf 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -1,21 +1,102 @@ -from docs_conf.conf import * +project = "onap" +release = "master" +version = "master" + +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 -branch = 'latest' -master_doc = 'index' extensions = [ - 'sphinx.ext.autosectionlabel', - 'sphinxcontrib.swaggerdoc' - ] + 'sphinx.ext.intersphinx', + 'sphinx.ext.graphviz', + 'sphinxcontrib.blockdiag', + 'sphinxcontrib.seqdiag', + 'sphinxcontrib.swaggerdoc', + 'sphinxcontrib.plantuml', + 'sphinx_toolbox.collapse', + 'sphinxcontrib.redoc' +] -linkcheck_ignore = [ - 'http://localhost', +redoc = [ + { + 'name': 'Policy API', + 'page': 'api/local-swagger', + 'spec': 'https://raw.githubusercontent.com/onap/policy-api/master/main/src/main/resources/openapi/openapi.yaml', + 'opts': { + 'lazy-rendering': True, + 'suppress-warnings': True, + 'hide-hostname': True, + } + }, + { + 'name': 'Policy PAP', + 'page': 'pap/local-swagger', + 'spec': 'https://raw.githubusercontent.com/onap/policy-pap/master/main/src/main/resources/openapi/openapi.yaml', + 'opts': { + 'lazy-rendering': False, + 'suppress-warnings': True, + 'hide-hostname': True, + } + }, + { + 'name': 'Policy XACML', + 'page': 'xacml/local-swagger', + 'spec': 'https://raw.githubusercontent.com/onap/policy-xacml-pdp/master/main/src/main/resources/openapi/openapi.yaml', + 'opts': { + 'lazy-rendering': False, + '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/master/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' -html_last_updated_fmt = '%d-%b-%y %H:%M' +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) +# -autosectionlabel_maxdepth = 2 +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(.*?)' +]