在对实际项目进行测试之前,我试图为测试Python项目创建文档。 我的系统:Win7 64位,Python2.7.5 64位。
我的项目名是testDoc。它包括python包,名为t,其中包括2个模块t1和t2和__init__.py
。
__init__.py
包含:
import t1
import t2
t1.py包含:
'''
Created on 27 2013
@author:
'''
class MyClass(object):
'''
Hi
'''
def __init__(self,selfparams):
'''
Constructor
'''
pass
要创建在命令行中运行的文档,请执行以下操作:
sphinx-apidoc -A "me" -F -o docs .
Sphinx创建了许多文件,根据Sphinx文档,这是可以的。 然后,conf.py被修改
sys.path.insert(0, os.path.abspath(absolute path to testDoc))
我输入文档文件夹并键入
make html
并得到以下错误输出:
Making output directory...
Running Sphinx v1.1.3
loading pickled environment... not yet created
building [html]: targets for 2 source files that are out of date
updating environment: 2 added, 0 changed, 0 removed
reading sources... [ 50%] index
reading sources... [100%] t
Traceback (most recent call last):
File "C:\Python27\lib\site-packages\sphinx\ext\autodoc.py", line 321, in impor
t_object
__import__(self.modname)
ImportError: No module named t.__init__
Traceback (most recent call last):
File "C:\Python27\lib\site-packages\sphinx\ext\autodoc.py", line 321, in impor
t_object
__import__(self.modname)
ImportError: No module named t.t1
Traceback (most recent call last):
File "C:\Python27\lib\site-packages\sphinx\ext\autodoc.py", line 321, in impor
t_object
__import__(self.modname)
ImportError: No module named t.t2
...testDoc\t\docs\t.rst:7: WARNING: a
autodoc can't import/find module 't.__init__', it reported error: "No module name
d t.__init__", please check your spelling and sys.path
...testDoc\t\docs\t.rst:15: WARNING:
autodoc can't import/find module 't.t1', it reported error: "No module named t.t
1", please check your spelling and sys.path
t...testDoc\t\docs\t.rst:23: WARNING:
autodoc can't import/find module 't.t2', it reported error: "No module named t.t
2", please check your spelling and sys.path
looking for now-outdated files... none found
pickling environment... done
checking consistency... done
preparing documents... done
writing output... [ 50%] index
writing output... [100%] t
writing additional files... (0 module code pages) genindex search
copying static files... done
dumping search index... done
dumping object inventory... done
build succeeded, 3 warnings.
Build finished. The HTML pages are in _build/html.
怎么了? 谢谢。
我不知道“testDoc的绝对路径”是什么,但是从Sphinx输出中我可以看到testDoc目录结构是
testDoc/t/docs
。docs
目录是conf.py所在的位置。要正确设置模块搜索路径,需要从conf.py向上分两级:
相关问题 更多 >
编程相关推荐