summaryrefslogtreecommitdiffstats
path: root/docs/conf.py
diff options
context:
space:
mode:
authorseanbeirne <sean.beirne@est.tech>2022-10-25 17:36:55 +0100
committerSean Beirne <sean.beirne@est.tech>2022-10-26 11:37:32 +0000
commit631910053a652f5c52cd624768d1a1c4fdfc3b1b (patch)
tree9a42d2aadcaa52bde43e9ea78d956735cf3acb08 /docs/conf.py
parent66cc5b46bbadf5f037b390e79a14464541bbb951 (diff)
Finialise documentation as per doc procedure p02
Issue-ID: CPS-1321 Signed-off-by: seanbeirne <sean.beirne@est.tech> Change-Id: Ibe269a391ac1c519693729b5e505342544913dd1 (cherry picked from commit a67e735c3dad9cbe21484fdbee44b6b16ec78595)
Diffstat (limited to 'docs/conf.py')
-rw-r--r--docs/conf.py48
1 files changed, 35 insertions, 13 deletions
diff --git a/docs/conf.py b/docs/conf.py
index 723fb21f..acf3927e 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -1,5 +1,5 @@
# ============LICENSE_START=======================================================
-# Copyright (C) 2021 Nordix Foundation
+# Copyright (C) 2022 Nordix Foundation
# ================================================================================
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
@@ -18,13 +18,44 @@
from docutils.parsers.rst import directives
-from docs_conf.conf import *
-#change 'latest' to relevant branch-name once branch has been created
+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']
+
+#
+# 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'
+
doc_url = 'https://docs.onap.org/projects'
master_doc = 'index'
+exclude_patterns = ['.tox']
+
+spelling_word_list_filename='spelling_wordlist.txt'
+spelling_lang = "en_GB"
+
intersphinx_mapping = {}
intersphinx_mapping['onap-cps'] = ('{}/onap-cps/en/%s'.format(doc_url) % branch, None)
@@ -33,16 +64,7 @@ intersphinx_mapping['onap-cps-cps-temporal'] = ('{}/onap-cps-cps-temporal/en/%s'
linkcheck_ignore = [
'http://localhost',
'https://example.com',
- 'about:config',
- # this URL is not directly reachable and must be configured in the system hosts file.
- 'https://portal.api.simpledemo.onap.org:30225/ONAPPORTAL/login.htm',
- # anchor issues
- 'https://docs.onap.org/projects/onap-integration/en/latest/docs_usecases_release.html#.*',
- 'https://docs.linuxfoundation.org/docs/communitybridge/easycla/contributors/contribute-to-a-gerrit-project#.*',
- 'https://docs.onap.org/projects/onap-integration/en/latest/docs_robot.html#docs-robot',
- 'https://docs.onap.org/projects/onap-integration/en/latest/docs_usecases_release.html#docs-usecases-release',
- 'https://docs.onap.org/projects/onap-integration/en/latest/docs_usecases.html#docs-usecases',
- 'https://docs.onap.org/projects/onap-integration/en/latest/usecases/release_non_functional_requirements.html#release-non-functional-requirements',
+ 'about:config'
]