lsst_doc_shortlink_titlecase_display_role

documenteer.sphinxext.lsstdocushare.lsst_doc_shortlink_titlecase_display_role(name, rawtext, text, lineno, inliner, options=None, content=None)

Link to LSST documents given their handle using LSST’s ls.st link shortener with the document handle displayed in title case.

This role is useful for Document, Report, Minutes, and Collection DocuShare handles.

Example:

:document:`1`

Parameters:

• name (str) –

• rawtext (str) –

• text (str) –

• lineno (int) –

• inliner (Inliner) –

• options (Optional[Dict], default: None) –

• content (Optional[List[str]], default: None) –

Return type:

Tuple[List[Node], List[system_message]]