Ctrl+K

Linking

Linking#

Applies to Linux and Windows

2024-02-09

3 min read time

Markdown#

Cross References to Other Projects#

When making links that cross-reference documentation sites, the following format should be used:

{doc}`Text here<project_name:path/to/page_name>`

The projects.yaml configuration file contains the names of projects that should be used when making links that cross-reference documentation sites.

Example#

The following Markdown:

{doc}`ROCm Documentation<rocm:reference/all>`

will be rendered as the following link:

ROCm Documentation

Other#

For other links, usual Markdown conventions should be used.

Table of Contents#

Syntax#

Variables of the form ${<variable>} are substituted, currently the following list is supported:

  • ${branch} or {branch}: the name of the current branch

  • ${url} or {url}: GitHub URL of the current project

  • ${project:<project_name>}: base URL of the documentation of <project_name> based on Intersphinx mapping

Example#

    - url: "{url}/tree/{branch}"
    - url: ${project:python}
    - url: ${project:rocm-docs-core}
    - url: ${project:hipify}
Contents