如何將模塊導入到 Sphinx

Question

import myModule as myModule

使用此代碼可以導入，我可以制作我的文檔

import myPackage.myModule as myModule

有了這個我得到

“沒有名為 myPackage.myModule 的模塊”

此文件是否存在於根目錄或 myPackage 目錄中無關緊要。

在 RST 文件中，我沒有提到 myModule，我想記錄其他只導入此模塊的文件。

Answer 1

Sphinx 需要能夠導入您的代碼，以生成類和函數的文檔。 您可能需要將項目的根文件夾添加到 Sphinx 中的 sys.path。 您可以從 Sphinx conf.py文件中執行此操作：

import sys
import os
sys.path.append(os.path.join(os.path.dirname(__file__), '..'))

將'..'替換為項目根目錄的相對路徑。