如何使用sphinx从模块的docstring引用* .rst文件

Question

我用rst格式写了一个小教程。现在，对于apidoc生成的文档，我想在docstring中引用该教程：

:any:`<my_tut>`

my_tut.rst位于我的Sphinx-documentation源文件夹的顶级目录中。但是，我收到了错误

WARNING: 'any' reference target not found: my_tut

添加信息：

apidoc的输出不在顶级源文件夹中，而是在名为code的子文件夹中。

Answer 1

:doc:角色可用于创建对my_tut.rst的交叉引用：

:doc:`my_tut`

如果链接源和链接目标位于不同的文件夹中，则需要将其考虑在内。目标高于源一级，它看起来像这样：

:doc:`../my_tut`

另一种方法是在my_tut.rst中的相关标题之前添加label，并将其用作交叉引用目标。如果标签定义为.. _my_label:，您可以像这样引用它：

:any:`my_label`

您也可以使用:ref:`my_label`。