将文件夹导入为模块时，如何生成Sphynx文档？

问题描述

我的代码和文档具有以下项目结构：

├───docs
│   ├───_build
│   ├───_static
│   ├───...
│   ├───conf.py
│   ├───index.srt
│   ├───make.bat
|   └───Makefile   
├───source
│   ├───script1.py
│   ├───script2.py
|   └───script3.py

我的conf.py：

import os
import sys
sys.path.insert(0,os.path.abspath('../source'))
...
extensions = ['sphinx.ext.autodoc']

我正在docs文件夹中运行sphinx-apidoc -o . ../source。它会为我的每个脚本生成一个新文件.rst。

我正在将modules添加到index.rst文件中

之后，我运行make html来生成我的文档。但这会发出警告，而不是为特定文件生成文档：

WARNING: autodoc: Failed to import module 'script3'; the following exception was raised:
No module named 'source'

我将问题隔离到在 script3.py 代码中创建的导入语句中：

from source.scripts2 import MyClass

因此，由于该文件夹不是模块，因此似乎引发了错误。但是我不确定如何解决。

我尝试在项目和源代码文件夹中创建空的__init__.py文件，但是错误仍然存在

我该如何解决？

解决方法

暂无找到可以解决该程序问题的有效方法，小编努力寻找整理中！

如果你已经找到好的解决方法，欢迎将解决方案带上本链接一起发送给小编。

小编邮箱:dio#foxmail.com (将#修改为@）

python python-sphinx