From c72b0875d2e8f4e9ce7868b846a466aa62467175 Mon Sep 17 00:00:00 2001 From: "halil.cakal" Date: Mon, 14 Nov 2022 15:46:34 +0100 Subject: Fix DOC config files Fix breaking API documentation generationi and replace ROBOT_VENV with ROBOT3_VENV Issue-ID: DOC-798 Signed-off-by: marineMD Change-Id: Ic9b887a8f6c96ed332cde9997efb3471e7e2e35f Signed-off-by: halil.cakal --- docs/conf.py | 53 +++++++++++++++++++++++++++++++++++++++++++++++------ 1 file changed, 47 insertions(+), 6 deletions(-) (limited to 'docs/conf.py') diff --git a/docs/conf.py b/docs/conf.py index 29923a05..1b1973cc 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -1,13 +1,38 @@ -from docs_conf.conf import * +project = "onap" +release = "kohn" +version = "kohn" -branch = 'latest' -master_doc = 'index' +author = "Open Network Automation Platform" +# yamllint disable-line rule:line-length +copyright = "ONAP. Licensed under Creative Commons Attribution 4.0 International License" -linkcheck_ignore = [ - 'http://localhost', +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', + 'sphinxcontrib.redoc', + 'sphinx_tabs.tabs' ] -extensions = ['sphinx_tabs.tabs', 'sphinxcontrib.redoc',] +# +# 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 = 'kohn' redoc = [ { @@ -27,8 +52,24 @@ redoc = [ redoc_uri = 'https://cdn.jsdelivr.net/npm/redoc@next/bundles/redoc.standalone.js' 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_css_file("css/ribbon.css") + +linkcheck_ignore = [ + r'http://localhost:\d+/' +] -- cgit 1.2.3-korg