如何使用sphinx從模塊的文檔字符串中引用* .rst文件

Question

我以rst格式編寫了一個小教程。現在由apidoc生成的文檔，我想引用教程中使用的文檔字符串：

:any:`<my_tut>` 

凡my_tut.rst是我的獅身人面像的文檔的源文件夾的頂級目錄。但是，我得到的錯誤

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`。