From a99f3c37fc7e93d01ed7c0422a069b28ffaaef35 Mon Sep 17 00:00:00 2001 From: Guangrong Fu Date: Tue, 1 Nov 2022 08:12:21 +0800 Subject: bugfix - fixed doc problems on the kohn branch Issue-ID: HOLMES-587 Signed-off-by: Guangrong Fu Change-Id: Ibb7b688273c46256fbc14955918f41337ee746f9 --- docs/conf.py | 53 +++++++++++++++++++++++++++++++++++++++++++++-------- 1 file changed, 45 insertions(+), 8 deletions(-) (limited to 'docs/conf.py') diff --git a/docs/conf.py b/docs/conf.py index db098a7..4b2fec5 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -1,19 +1,56 @@ -from docs_conf.conf import * +project = "onap" +release = "kohn" +version = "kohn" -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" -branch = 'latest' -master_doc = 'index' +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 -linkcheck_ignore = [ - 'http://localhost', +extensions = [ + 'sphinx.ext.intersphinx', + 'sphinx.ext.graphviz', + 'sphinxcontrib.blockdiag', + 'sphinxcontrib.seqdiag', + 'sphinxcontrib.swaggerdoc', + 'sphinxcontrib.plantuml' ] +# +# 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' + 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) +# + +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+/' +] \ No newline at end of file -- cgit 1.2.3-korg