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

我用

rst

格式写了一个小教程。现在，对于

apidoc

生成的文档，我想在docstring中使用以下内容参考该教程：

:any:`<my_tut>`

新增信息：

apidoc

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

code

的子文件夹中。该角色可用于创建对my_tut.rst的交叉引用：

:doc:`my_tut`

如果链接源和链接目标位于不同的文件夹中，则需要考虑这一点。如果目标在源上一个级别，则如下所示：

:doc:`../my_tut`

:any:`my_label`

---

另一种方法是在my_tut.rst中的相关标题前添加一个，并将其用作交叉参考目标。如果标签定义为

_我的标签：

，您可以这样引用它：

:doc:`../my_tut`

:any:`my_label`

---

您还可以使用

：ref:`my_label`

如果拆下角括号，是否有效<代码>：any:`my_tut`。这需要定义为

的标签_我的啧啧：

。行得通。不知道为什么引用文件不起作用。若要引用文件，请使用

doc

角色：

：doc:`my_tut`

。我尝试过，但不起作用。如果文件位于源文件夹中，我不必给出相对路径，是吗？也许您必须提供相对路径。文档字符串的输出是否与my_tut.rst的输出在不同的文件夹中？