如何解决将文件夹导入为模块时,如何生成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
。
之后,我运行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 举报,一经查实,本站将立刻删除。