如何将模块导入sphinx

Question

import myModule as myModule

使用此代码可以导入，我可以创建我的文档

import myPackage.myModule as myModule

用这个我得到“没有名为myPackage.myModule的模块” 无论此文件是存在于根目录还是存在于myPackage目录中。

在RST-File中的

我没有提到myModule，我想记录只导入这个模块的其他文件。

Answer 1

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

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

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