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
collection	Link to a DocuShare “Collection” handle
ittn	Link to an ITTN technical note
dmtn	Link to a DMTN technical note
dmtr	Link to a DMTR document
document	Link to a DocuShare “Document” handle
lca	Link to an LCA document
lcn	Link to an LCN document
lcr	Link to an LCR document
ldm	Link to an LDM document
lep	Link to an LEP document
lpm	Link to an LPM document
lse	Link to an LSE document
lsstc	Link to an LSSTC document
lso	Link to an LSO document
lts	Link to an LTS document
minutes	Link to a DocuShare “Minutes” handle
pstn	Link to a PSTN technical note
rtn	Link to an RTN technical note
sitcomtn	Link to a SITCOMTN technical note
smtn	Link to a SMTN technical note
sqr	Link to a SQR technical note
tstn	Link to a Telescope & Site technical note
report	Link to a DocuShare “Report” handle

Roles

Links DocuShare

:collection:

Link to a DocuShare “Collection” handle.

:dmtr:

Link to a DMTR document:

:dmtr:`141`

Output: DMTR-141

:document:

Link to a DocuShare “Document” handle.

:lca:

Link to an LCA document:

:lca:`227`

Output: LCA-227

:lcn:

Link to an LCN document.

:lcr:

Link to an LCR document.

:ldm:

Link to an LDM document:

:ldm:`294`

Output: LDM-294

:lep:

Link to an LEP document:

:lep:`031`

Output: LEP-031

:lpm:

Link to an LPM document:

:lpm:`51`

Output: LPM-51

:lse:

Link to an LSE document:

:lse:`160`

Output: LSE-160

:lsstc:

Link to an LSSTC document.

:lso:

Link to an LSO document:

:lso:`011`

Output: LSO-011

:lts:

Link to an LTS document:

:lts:`488`

Output: LTS-488

:minutes:

Link to a DocuShare “Minutes” handle.

:report:

Link to a DocuShare “Report” handle.

Links to technical notes on lsst.io

:dmtn:

Link to a DMTN document:

:dmtn:`000`

Output: DMTN-000

:ittn:

Link to an ITTN document:

:ittn:`001`

Output: ITTN-001

:pstn:

Link to a PSTN document:

:pstn:`001`

Output: PSTN-001

:rtn:

Link to an RTN document:

:rtn:`001`

Output: RTN-001

:sitcomtn:

Link to a SITCOMTN document:

:sitcomtn:`001`

Output: SITCOMTN-001

:smtn:

Link to a SMTN document:

:smtn:`001`

Output: SMTN-001

:sqr:

Link to a SQR document:

:sqr:`000`

Output: SQR-000

:tstn:

Link to a TSTN document:

:tstn:`001`

Output: TSTN-001