Jira reference roles

Documenteer provides reStructuredText roles to simplify linking to issues in LSST’s Jira ticketing system at https://jira.lsstcorp.org.

To use these roles, add the documenteer.sphinxext.jira extension to your conf.py file:

extensions = [
    ...
    'documenteer.sphinxext.jira'
]

Roles

:jira:

Link to a Jira issue using the issue ID as an argument. Example:

:jira:`DM-22957`

Output: DM-22957

:jirap:

Link to a Jira issue using the issue ID as an argument, with the link enclosed in parentheses. Example:

:jirap:`DM-22957`

Output: (DM-22957)

:jirab:

Link to a Jira issue using the issue ID as an argument, with the link enclosed in square brackets. Example:

:jirab:`DM-22957`

Output: [DM-22957]