Linking in RST#
Applies to Linux and Windows
2024-08-01
2 min read time
reStructuredText (RST)#
Cross References to Arbitrary Locations in Other Projects#
The projects.yaml configuration file contains the names of projects that should be used when making links that cross-reference documentation sites.
Cross references to anchors or arbitrary locations in documentation can be done using labels.
See the Sphinx documentation on cross-referencing arbitrary locations for information on labels.
The format using a label would appear as follows:
:ref:`Text here<project_name:label_name>`
Cross-references are achieved via Intersphinx. For more information, refer to the Sphinx documentation or Read the Docs documentation on Intersphinx.
Example#
The following RST:
:ref:`ROCm for AI Install<rocm:rocm-for-ai-install>`
will be rendered as the following link: