警告
您正在阅读的 ROS 2 文档版本已达到 EOL（生命周期结束），不再受官方支持。如果您想了解最新信息，请访问 Jazzy.
使用 Sphinx 对软件包进行交叉引用
本页提供了如何使用 Sphinx 在 rosindex 中交叉引用软件包文档的快速指南。
清单文件必须添加到 ROSIndex Sphinx 的 conf.py 找到文件 这里.请注意 通用资源识别号 的目录。 .inv 而不是文件本身（即 https://docs.ros.org/independent/api/catkin_pkg 而不是 https://docs.ros.org/independent/api/catkin_pkg/objects.inv).
显示 Intersphinx 制图文件的所有链接
(部分借自 这里).
要显示本地或远程 Intersphinx 映射文件的所有 Intersphinx 链接及其目标，请运行
蟒蛇 -msphinx.ext.intersphinx "url-or-path-to-inv-file"；
这有助于在文档项目中查找 Intersphinx 链接断开的根本原因。
使用 Intersphinx 链接到其他网站
(部分借自 这里).
您可以提供明确的标题和参考目标：
:role:\`title target>\`将指向目标，但链接文本将是标题。如果在内容前加上 !，则不会创建引用/超链接。
如果在内容前加上 ~，链接文本就只能是目标内容的最后一个组成部分。例如
:py:meth:\`~Queue.Queue.get\`将指Queue.Queue.get但只显示 get 作为链接文本。
髋关节间隙的应用实例
链接到 源代码 的创建方法如下：
备注
班级 vcstools.VcsClient 实现 vcstools.VcsClient.checkout() 方法。
本文档中其他页面的链接：
备注
参见 安装页面.
参见 安装页面.