Skip to main content
Ctrl+K

Documenteer

  • Rubin user guides
  • Technical notes
  • Sphinx extensions
  • Change Log
  • Development
    • Rubin docs
  • GitHub
  • Rubin user guides
  • Technical notes
  • Sphinx extensions
  • Change Log
  • Development
  • Rubin docs
  • GitHub

Section Navigation

Guides

  • Development guide
  • Release procedure

Architecture

  • Theming architecture overview
    • Handling CSS, JavaScript, and image assets
    • Handling Jinja HTML templates

Reference

  • Python API
    • documenteer.conf
      • get_asset_path
      • extend_static_paths_with_asset_extension
      • extend_excludes_for_non_index_source
      • get_template_dir
      • DocumenteerConfig
      • ConfigRoot
      • ProjectModel
      • PythonPackageModel
      • OpenApiDocsModel
      • OpenApiGeneratorModel
      • SphinxModel
      • IntersphinxModel
      • LinkCheckModel
      • ThemeModel
    • documenteer.ext
      • generate_openapi_spec
      • setup
      • setup
      • LsstBibtexStyle
      • jira_bracket_role
      • jira_parens_role
      • jira_role
      • setup
      • lsst_doc_shortlink_role
      • lsst_doc_shortlink_titlecase_display_role
      • lsstio_doc_shortlink_role
      • setup
      • mock_code_ref_role
      • setup
  • Development
  • Python API
  • documenteer.ext
  • lsst_doc_shortlink_titlecase_display_role

lsst_doc_shortlink_titlecase_display_role#

documenteer.ext.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 (dict | None, default: None)

  • content (list[str] | None, default: None)

Return type:

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

previous

lsst_doc_shortlink_role

next

lsstio_doc_shortlink_role

On this page
  • lsst_doc_shortlink_titlecase_display_role()
Edit on GitHub

© Copyright 2015-2022 Association of Universities for Research in Astronomy, Inc. (AURA).

Created using Sphinx 8.1.3.

Built with the PyData Sphinx Theme 0.16.1.