From 52b199903f5ad4e4f4d890da5f30d1c9973e4243 Mon Sep 17 00:00:00 2001 From: thmsdt Date: Tue, 4 Oct 2022 11:33:10 +0200 Subject: fix doc config files Issue-ID: DOC-798 Signed-off-by: thmsdt Change-Id: Ifb3ca80f231c8d2e1742f0bde1c647204a2b8d82 --- docs/conf.py | 61 ++++++++++++++++++++++++++++++++++++++++++++---------------- 1 file changed, 45 insertions(+), 16 deletions(-) (limited to 'docs/conf.py') diff --git a/docs/conf.py b/docs/conf.py index f6aebe82..5e4ffbdb 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -1,26 +1,55 @@ -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 + +extensions = [ + 'sphinx.ext.intersphinx','sphinxcontrib.blockdiag', + 'sphinxcontrib.seqdiag', 'sphinxcontrib.swaggerdoc', 'sphinx.ext.graphviz', + 'sphinxcontrib.openapi'] + +# +# 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' -linkcheck_ignore = [ - 'http://localhost', - 'http://ejbca', - 'https://localhost', - 'https://download.primekey.com' -] +exclude_patterns = ['.tox'] -exclude_patterns = [ - '.tox' -] +spelling_word_list_filename='spelling_wordlist.txt' +spelling_lang = "en_GB" -extensions = [ - 'sphinxcontrib.openapi', -] -intersphinx_mapping = {} +# +# 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") \ No newline at end of file + app.add_css_file("css/ribbon.css") + +linkcheck_ignore = [ + 'http://localhost', + 'http://ejbca', + 'https://localhost', + 'https://download.primekey.com' +] -- cgit 1.2.3-korg