LSST document reference roles

Documenteer provides reStructuredText roles that simplify linking to LSST documents according to their handle.

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

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

Summary

Document link roles

Role	Purpose
ldm	Link to an LDM document
lse	Link to an LSE document
lpm	Link to an LPM document
lts	Link to an LTS document
lep	Link to an LEP document
lca	Link to an LCA document
lcr	Link to an LCR document
lso	Link to an LSO document
dmtr	Link to a DMTR document
sqr	Link to a SQR document
smtn	Link to a SMTN document
document	Link to a DocuShare “Document” handle
report	Link to a DocuShare “Report” handle
minutes	Link to a DocuShare “Minutes” handle
collection	Link to a DocuShare “Collection” handle

Roles

:ldm:

Link to an LDM document:

:ldm:`294`

Output: LDM-294

:lse:

Link to an LSE document:

:lse:`160`

Output: LSE-160

:lpm:

Link to an LPM document:

:lpm:`51`

Output: LPM-51

:lts:

Link to an LTS document:

:lts:`488`

Output: LTS-488

:lep:

Link to an LEP document:

:lep:`031`

Output: LEP-031

:lca:

Link to an LCA document:

:lca:`227`

Output: LCA-227

:lsstc:

Link to an LSSTC document.

:lcr:

Link to an LCR document.

:lcn:

Link to an LCN document.

:lso:

Link to an LSO document:

:lso:`011`

Output: LSO-011

:dmtr:

Link to a DMTR document:

:dmtr:`141`

Output: DMTR-141

:sqr:

Link to a SQR document:

:sqr:`000`

Output: SQR-000

:dmtn:

Link to a DMTN document:

:dmtn:`000`

Output: DMTN-000

:smtn:

Link to a SMTN document:

:smtn:`001`

Output: SMTN-001

:document:

Link to a DocuShare “Document” handle.

:report:

Link to a DocuShare “Report” handle.

:minutes:

Link to a DocuShare “Minutes” handle.

:collection:

Link to a DocuShare “Collection” handle.