Linking in the Table of Contents

Contents

Linking in the Table of Contents#

Applies to Linux and Windows

2024-08-01

2 min read time

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