Skip to main content
Ctrl+K
Logo image Logo image

Documenteer

Site Navigation

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

Site Navigation

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

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
      • setup
      • generate_openapi_spec
      • 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
    • documenteer.requestsutils
      • requests_retry_session

lsstio_doc_shortlink_role¶

documenteer.ext.lsstdocushare.lsstio_doc_shortlink_role(name, rawtext, text, lineno, inliner, options=None, content=None)¶

Link to LSST documents given their handle that are hosted on lsst.io (Rubin’s deployment of LSST the Docs).

Example:

:sqr:`001`
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_titlecase_display_role

next

setup

On this page
  • lsstio_doc_shortlink_role()
Edit this page

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

Built with the PyData Sphinx Theme 0.12.0.

Created using Sphinx 8.1.3.