Jira and other Links¶
Links¶
Links to Jira objects are set directly in the Sphinx-Needs objects by using string-links.
See the needs below.
Additonally, a string-links setting needs to be added to the ubproject.toml file.
# ubproject.toml
[needs.string_links.jira_link]
# Links to the related jira issue
link_name = "JIRA ADAS #{{value}}"
link_url = "https://useblocks.atlassian.net/browse/ADAS-{{value}}"
options = ["jira"]
regex = "^(?P<value>\\w+)$"
… or to the conf.py file:
# conf.py
needs_string_links = {
'custom_name': {
'regex': "...",
'link_url' : "...",
'link_name': '...'
'options': ['status', '...']
}
}
# Examples
needs_string_links = {
# Adds link to the Sphinx-Needs configuration page
'config_link': {
'regex': r'^(?P<value>\w+)$',
'link_url': 'https://sphinx-needs.readthedocs.io/en/latest/configuration.html#{{value | replace("_", "-")}}',
'link_name': 'Sphinx-Needs docs for {{value | replace("_", "-") }}',
'options': ['config']
},
# Links to the related github issue
'github_link': {
'regex': r'^(?P<value>\w+)$',
'link_url': 'https://github.com/useblocks/sphinx-needs/issues/{{value}}',
'link_name': 'GitHub #{{value}}',
'options': ['github']
}
}
status: open
jira: 1
links incoming: REQ_001
|
The system shall detect lane markings and provide corrective steering input to keep the vehicle within the lane. |