python - 如何将模块导入 Sphinx

Question

import myModule as myModule

使用此代码导入，我可以制作我的文档

import myPackage.myModule as myModule

有了这个我得到

"No module named myPackage.myModule"

此文件是否存在于根目录或 myPackage 目录中并不重要。
在我没有提到 myModule 的 RST-File 中，我想记录其他只导入此模块的文件。

Answer 1

Sphinx 需要能够导入您的代码，以生成类和函数的文档。您可能需要将项目的根文件夹添加到 Sphinx 中的 sys.path。您可以从 Sphinx conf.py 执行此操作文件:

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

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