jira_parens_role

documenteer.ext.jira.jira_parens_role(name, rawtext, text, lineno, inliner, options=None, content=None)

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

Examples:

:jirap:`DM-6181` -> (DM-6181)
:jirap:`DM-6181,DM-6181` -> (DM-6180, DM-6181)
:jirap:`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)

Return type:

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