blob: 8b63262d13c755f98e678c8d00d859ba2411fc5e [file] [log] [blame]
Timoney, Dan (dt5972)62d15552022-11-04 16:04:24 -04001project = "onap"
2release = "master"
3version = "master"
Jessica Wagantall6497df02020-02-06 15:04:58 -08004
Timoney, Dan (dt5972)62d15552022-11-04 16:04:24 -04005author = "Open Network Automation Platform"
marineMDdced5a42022-11-14 15:22:05 +01006# yamllint disable-line rule:line-length
Timoney, Dan (dt5972)62d15552022-11-04 16:04:24 -04007copyright = "ONAP. Licensed under Creative Commons Attribution 4.0 International License"
marineMDdced5a42022-11-14 15:22:05 +01008
Timoney, Dan (dt5972)62d15552022-11-04 16:04:24 -04009pygments_style = "sphinx"
10html_theme = "sphinx_rtd_theme"
11html_theme_options = {
12 "style_nav_header_background": "white",
13 "sticky_navigation": "False" }
thmsdtb7f4ad42024-08-14 10:15:28 +020014html_logo = "_static/logo_onap_2024.png"
Timoney, Dan (dt5972)62d15552022-11-04 16:04:24 -040015html_favicon = "_static/favicon.ico"
16html_static_path = ["_static"]
17html_show_sphinx = False
marineMDdced5a42022-11-14 15:22:05 +010018
Timoney, Dan (dt5972)62d15552022-11-04 16:04:24 -040019extensions = [
20 'sphinx.ext.intersphinx',
21 'sphinx.ext.graphviz',
22 'sphinxcontrib.blockdiag',
23 'sphinxcontrib.seqdiag',
24 'sphinxcontrib.swaggerdoc',
25 'sphinxcontrib.plantuml'
Jessica Wagantall6497df02020-02-06 15:04:58 -080026]
marineMDdced5a42022-11-14 15:22:05 +010027
Timoney, Dan (dt5972)62d15552022-11-04 16:04:24 -040028#
29# Map to 'latest' if this file is used in 'latest' (master) 'doc' branch.
30# Change to {releasename} after you have created the new 'doc' branch.
31#
marineMDdced5a42022-11-14 15:22:05 +010032
Timoney, Dan (dt5972)62d15552022-11-04 16:04:24 -040033branch = 'latest'
marineMDdced5a42022-11-14 15:22:05 +010034
Jessica Wagantall6497df02020-02-06 15:04:58 -080035intersphinx_mapping = {}
Timoney, Dan (dt5972)62d15552022-11-04 16:04:24 -040036doc_url = 'https://docs.onap.org/projects'
37master_doc = 'index'
marineMDdced5a42022-11-14 15:22:05 +010038
Timoney, Dan (dt5972)62d15552022-11-04 16:04:24 -040039exclude_patterns = ['.tox']
marineMDdced5a42022-11-14 15:22:05 +010040
Timoney, Dan (dt5972)62d15552022-11-04 16:04:24 -040041spelling_word_list_filename='spelling_wordlist.txt'
42spelling_lang = "en_GB"
marineMDdced5a42022-11-14 15:22:05 +010043
Timoney, Dan (dt5972)62d15552022-11-04 16:04:24 -040044#
45# Example:
46# intersphinx_mapping['onap-aai-aai-common'] = ('{}/onap-aai-aai-common/en/%s'.format(doc_url) % branch, None)
47#
marineMDdced5a42022-11-14 15:22:05 +010048
Jessica Wagantall6497df02020-02-06 15:04:58 -080049html_last_updated_fmt = '%d-%b-%y %H:%M'
marineMDdced5a42022-11-14 15:22:05 +010050
Jessica Wagantall6497df02020-02-06 15:04:58 -080051def setup(app):
lf-jobbuilderd691e9a2020-05-28 13:59:16 -070052 app.add_css_file("css/ribbon.css")
marineMDdced5a42022-11-14 15:22:05 +010053
Timoney, Dan (dt5972)62d15552022-11-04 16:04:24 -040054linkcheck_ignore = [
55 r'http://localhost:\d+/'
56]