1 # ============LICENSE_START=======================================================
2 # Copyright (C) 2021 Nordix Foundation
3 # ================================================================================
4 # Licensed under the Apache License, Version 2.0 (the "License");
5 # you may not use this file except in compliance with the License.
6 # You may obtain a copy of the License at
8 # http://www.apache.org/licenses/LICENSE-2.0
10 # Unless required by applicable law or agreed to in writing, software
11 # distributed under the License is distributed on an "AS IS" BASIS,
12 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 # See the License for the specific language governing permissions and
14 # limitations under the License.
16 # SPDX-License-Identifier: Apache-2.0
17 # ============LICENSE_END=========================================================
19 from docutils.parsers.rst import directives
25 author = "Open Network Automation Platform"
26 # yamllint disable-line rule:line-length
27 copyright = "ONAP. Licensed under Creative Commons Attribution 4.0 International License"
29 pygments_style = "sphinx"
30 html_theme = "sphinx_rtd_theme"
31 html_theme_options = {
32 "style_nav_header_background": "white",
33 "sticky_navigation": "False" }
34 html_logo = "_static/logo_onap_2017.png"
35 html_favicon = "_static/favicon.ico"
36 html_static_path = ["_static"]
37 html_show_sphinx = False
40 'sphinx.ext.intersphinx','sphinxcontrib.blockdiag',
41 'sphinxcontrib.seqdiag', 'sphinxcontrib.swaggerdoc', 'sphinx.ext.graphviz',
42 'sphinxcontrib.spelling']
45 # Map to 'latest' if this file is used in 'latest' (master) 'doc' branch.
46 # Change to {releasename} after you have created the new 'doc' branch.
51 doc_url = 'https://docs.onap.org/projects'
54 exclude_patterns = ['.tox']
56 spelling_word_list_filename='spelling_wordlist.txt'
57 spelling_lang = "en_GB"
59 intersphinx_mapping = {}
61 intersphinx_mapping['onap-cps-ncmp-dmi-plugin'] = ('{}/onap-cps-ncmp-dmi-plugin/en/%s'.format(doc_url) % branch, None)
62 intersphinx_mapping['onap-cps-cps-temporal'] = ('{}/onap-cps-cps-temporal/en/%s'.format(doc_url) % branch, None)
66 'https://example.com',
71 html_last_updated_fmt = '%d-%b-%y %H:%M'
75 app.add_css_file("css/ribbon.css")
78 needs_extra_options = {
79 "target": directives.unchanged,
80 "keyword": directives.unchanged,
81 "introduced": directives.unchanged,
82 "updated": directives.unchanged,
83 "impacts": directives.unchanged,
84 "validation_mode": directives.unchanged,
85 "validated_by": directives.unchanged,
86 "test": directives.unchanged,
87 "test_case": directives.unchanged,
88 "test_file": directives.unchanged,
89 "notes": directives.unchanged,
92 needs_id_regex = "^[A-Z0-9]+-[A-Z0-9]+"
93 needs_id_required = True
94 needs_title_optional = True
96 needs_template_collapse = """
99 {% if hide == false -%}
101 .. role:: needs_status
104 .. role:: needs_title
107 .. rst-class:: need_{{type_name}}
111 `{{id}}` - {{content|indent(4)}}
113 .. container:: toggle
115 .. container:: header
119 {% if status and status|upper != "NONE" and not hide_status %} | status: :needs_status:`{{status}}`{% endif %}
120 {% if tags and not hide_tags %} | tags: :needs_tag:`{{tags|join("` :needs_tag:`")}}`{% endif %}
121 {% if keyword %} | keyword: `{{keyword}}` {% endif %}
122 {% if target %} | target: `{{target}}` {% endif %}
123 {% if introduced %} | introduced: `{{introduced}}` {% endif %}
124 {% if updated %} | updated: `{{updated}}` {% endif %}
125 {% if impacts %} | impacts: `{{impacts}}` {% endif %}
126 {% if validation_mode %} | validation mode: `{{validation_mode}}` {% endif %}
127 {% if validated_by %} | validated by: `{{validated_by}}` {% endif %}
128 {% if test %} | test: `{{test}}` {% endif %}
129 {% if test_case %} | test case: {{test_case}} {% endif %}
130 {% if test_file %} | test file: `{{test_file}}` {% endif %}
131 {% if notes %} | notes: `{{notes}}` {% endif %}
132 | children: :need_incoming:`{{id}}`
133 | parents: :need_outgoing:`{{id}}`