jira_role

documenteer.ext.jira.jira_role(name, rawtext, text, lineno, inliner, options=None, content=None, *, oxford_comma=True)

Sphinx role for referencing a JIRA ticket.

Examples:

:jira:`DM-6181` -> DM-6181
:jira:`DM-6181,DM-6181` -> DM-6180 and DM-6181
:jira:`DM-6181,DM-6181,DM-6182` -> DM-6180, DM-6181, and DM-6182

Parameters:

• name (str)

• rawtext (str)

• text (str)

• lineno (int)

• inliner (Inliner)

• options (dict | None, default: None)

• content (list | None, default: None)

• oxford_comma (bool, default: True)

Return type:

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