blob: 3a63e0fab3f4c3df91eb65ad488fb05c14b4a39c [file] [log] [blame]
efiacor0fb3b8f2022-10-28 15:29:26 +01001project = "onap"
Andreas Geissler580c2002023-06-20 11:38:39 +02002release = "master"
3version = "master"
Jessica Wagantalld236cfc2020-02-06 15:00:26 -08004
efiacor0fb3b8f2022-10-28 15:29:26 +01005author = "Open Network Automation Platform"
6# yamllint disable-line rule:line-length
7copyright = "ONAP. Licensed under Creative Commons Attribution 4.0 International License"
Jessica Wagantalld236cfc2020-02-06 15:00:26 -08008
efiacor0fb3b8f2022-10-28 15:29:26 +01009pygments_style = "sphinx"
10html_theme = "sphinx_rtd_theme"
11html_theme_options = {
12 "style_nav_header_background": "white",
13 "sticky_navigation": "False" }
thmsdt43acd642024-08-14 10:24:21 +020014html_logo = "_static/logo_onap_2024.png"
efiacor0fb3b8f2022-10-28 15:29:26 +010015html_favicon = "_static/favicon.ico"
16html_static_path = ["_static"]
17html_show_sphinx = False
18
19extensions = [
20 'sphinx.ext.intersphinx',
21 'sphinx.ext.graphviz',
22 'sphinxcontrib.blockdiag',
23 'sphinxcontrib.seqdiag',
24 'sphinxcontrib.swaggerdoc',
25 'sphinxcontrib.plantuml',
26 'sphinx_toolbox.collapse'
Jessica Wagantalld236cfc2020-02-06 15:00:26 -080027]
28
efiacor0fb3b8f2022-10-28 15:29:26 +010029exclude_patterns = ['archived/*.rst', '.tox']
30#
31# Map to 'latest' if this file is used in 'latest' (master) 'doc' branch.
32# Change to {releasename} after you have created the new 'doc' branch.
33#
34
Andreas Geissler580c2002023-06-20 11:38:39 +020035branch = 'master'
efiacor0fb3b8f2022-10-28 15:29:26 +010036
Jessica Wagantalld236cfc2020-02-06 15:00:26 -080037intersphinx_mapping = {}
efiacor0fb3b8f2022-10-28 15:29:26 +010038doc_url = 'https://docs.onap.org/projects'
39master_doc = 'index'
40
41spelling_word_list_filename='spelling_wordlist.txt'
42spelling_lang = "en_GB"
43
44#
45# Example:
46# intersphinx_mapping['onap-aai-aai-common'] = ('{}/onap-aai-aai-common/en/%s'.format(doc_url) % branch, None)
47#
Jessica Wagantalld236cfc2020-02-06 15:00:26 -080048
49html_last_updated_fmt = '%d-%b-%y %H:%M'
50
efiacor0fb3b8f2022-10-28 15:29:26 +010051
Jessica Wagantalld236cfc2020-02-06 15:00:26 -080052def setup(app):
efiacor0fb3b8f2022-10-28 15:29:26 +010053 app.add_css_file("css/ribbon.css")
54
55
56linkcheck_ignore = [
Andreas Geissler9eb2c112022-11-21 14:13:23 +010057 "https://istio-release.storage.googleapis.com/charts",
Andreas Geisslere08eee02023-04-21 14:21:37 +020058 "https://charts.bitnami.com/bitnami",
59 "https://codecentric.github.io/helm-charts",
efiacor0fb3b8f2022-10-28 15:29:26 +010060 r'http://localhost:\d+/'
Andreas Geissler0ebd1ae2022-11-10 13:07:55 +010061]