jira_bracket_role

documenteer.ext.jira.jira_bracket_role(name, rawtext, text, lineno, inliner, options=None, content=None, open_symbol='[', close_symbol=']')

Sphinx role for referencing a JIRA ticket with ticket numbers enclosed in braces. Useful for changelogs.

Examples:

:jirab:`DM-6181` -> [DM-6181]
:jirab:`DM-6181,DM-6181` -> [DM-6180, DM-6181]
:jirab:`DM-6181,DM-6181,DM-6182` -> [DM-6180, DM-6181, DM-6182]
Parameters:

  • name (str)

  • rawtext (str)

  • text (str)

  • lineno (int)

  • inliner (Inliner)

  • options (dict | None, default: None)

  • content (bool | None, default: None)

  • open_symbol (str, default: '[')

  • close_symbol (str, default: ']')

Return type:

tuple[list[Node], list[system_message]]