aboutsummaryrefslogtreecommitdiffstats
path: root/docs/conf.py
diff options
context:
space:
mode:
authorJosephKeenan <joseph.keenan@est.tech>2022-09-01 11:39:47 +0100
committerJosephKeenan <joseph.keenan@est.tech>2022-09-01 15:38:18 +0100
commite68aec1e344011d894e4f3df698f42c774dad7d6 (patch)
tree67de4efb5625e58e5dae317f9ff0e00897d63df3 /docs/conf.py
parentc1915b5af27e4ee3ff89fd881e753e029a0bf5da (diff)
Adding config for RTD
-added config to files related to https://gerrit.onap.org/r/c/cps/+/130246/29 Issue-ID: CPS-1237 Signed-off-by: JosephKeenan <joseph.keenan@est.tech> Change-Id: Ia2fe7d2ecf3bb33608139c5fbf1328dc211f5629
Diffstat (limited to 'docs/conf.py')
-rwxr-xr-xdocs/conf.py47
1 files changed, 34 insertions, 13 deletions
diff --git a/docs/conf.py b/docs/conf.py
index 84dac1ea21..5185b61cd3 100755
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -16,15 +16,45 @@
# SPDX-License-Identifier: Apache-2.0
# ============LICENSE_END=========================================================
-
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-ncmp-dmi-plugin'] = ('{}/onap-cps-ncmp-dmi-plugin/en/%s'.format(doc_url) % branch, None)
@@ -33,16 +63,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'
]