如何将模块导入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__), '..'))

把'..'替换成项目根目录的相对路径。