Sphinx conf.py 找不到我的外部类

Question

我的文件夹结构如下所示：

root/
—docs/
  -source/
    -_utils/
      -utils.py
    -conf.py

在conf.py中我想从utils.py文件导入一个类。

我做这个

from _utils.utils import MyClass

然后在 docs 目录中，执行 make 命令。

我收到 ModuleNotFound 错误，指出找不到“_utils”模块。

Answer 1

conf.py

不一定是普通的Python模块，而是专门加载的配置文件。它可能无法进行相对导入。

如果你想在Sphinx的conf.py解决方案中导入自己的Python代码

• 使您的代码成为Python包的一部分，并使用pip、Poetry等工具安装您自己的包
• 操作

  sys.path

  或

  PYTHONPATH

  环境变量以包含要导入代码的任何文件夹