我试着从狮身人面像开始,似乎遇到了无情的问题
命令:docs/sphinx快速启动
我回答了所有的问题,一切都很好
命令:docs/ls
一切看起来都很正常。结果:buildmakefile源代码
命令:sphinx build-d build/doctrees源代码build/html
它似乎起作用了。我能够打开index.html文件,看到我想要的东西的“外壳”
当我尝试将实际的源代码作为source文件夹时,我遇到了问题
命令:sphinx build-d build/doctrees../ys\u utils build/html
结果:
正在生成输出目录。。。
运行Sphinx v1.1.3
正在加载酸洗环境。。。尚未创建
未选择任何生成器,使用默认值:html
从中加载intersphinx资源清册http://docs.python.org/objects.inv…
building[html]:1个过期源文件的目标
更新环境:添加1个,更改0个,删除0个
回溯(最近一次呼叫最后一次):
导入对象中的文件“/usr/local/lib/python2.6/dist packages/Sphinx-1.1.3-py2.6.egg/Sphinx/ext/autodoc.py”,第321行
__导入(self.modname)
ImportError:没有名为ys_utils的模块
回溯(最近一次呼叫最后一次):
导入对象中的文件“/usr/local/lib/python2.6/dist packages/Sphinx-1.1.3-py2.6.egg/Sphinx/ext/autodoc.py”,第321行
__导入(self.modname)
ImportError:没有名为ys\u utils.test\u validate\u ut的模块
回溯(最近一次呼叫最后一次):
导入对象中的文件“/usr/local/lib/python2.6/dist packages/Sphinx-1.1.3-py2.6.egg/Sphinx/ext/autodoc.py”,第321行
__导入(self.modname)
ImportError:没有名为ys_utils.git_utils的模块
回溯(最近一次呼叫最后一次):
导入对象中的文件“/usr/local/lib/python2.6/dist packages/Sphinx-1.1.3-py2.6.egg/Sphinx/ext/autodoc.py”,第321行
__导入(self.modname)
ImportError:没有名为setup.setup的模块
/home/ricomos/workspace/nextgen/ys_utils/ys_utils.rst:4:警告:autodoc无法导入/查找模块“ys_utils”,它报告了错误:“没有名为ys_utils的模块”,请检查拼写和sys.path
/home/ricomos/workspace/nextgen/ys_utils/ys_utils.rst:10:警告:autodoc无法导入/查找模块“ys_utils.test_validate_ut”,它报告了错误:“没有名为ys_utils.test_validate_ut的模块”,请检查拼写和sys.path
/home/ricomos/workspace/nextgen/ys_-utils/ys_-utils.rst:12:警告:不知道要导入哪个模块以自动记录u’UnitTests(尝试在文档中放置“module”或“currentmodule”指令,或给出明确的模块名称)
/home/ricomos/workspace/nextgen/ys_-utils/ys_-utils.rst:18:警告:autodoc无法导入/查找模块“ys_-utils.git_-utils”,它报告了错误:“没有名为ys_-utils.git_-utils的模块”,请检查拼写和sys.path
/home/ricomos/workspace/nextgen/ys_utils/ys_utils.rst:24:警告:autodoc无法导入/查找模块’setup.setup’,它报告错误:“没有名为setup.setup的模块”,请检查拼写和sys.path
警告:找不到主文件/home/ricomos/workspace/nextgen/ys_utils/index.rst
正在查找现在过时的文件。。。找不到
酸洗环境。。。完成
正在检查一致性/home/ricomos/workspace/nextgen/ys_utils/ys_utils.rst::警告:任何目录树中都不包含文档
完成
正在准备文档。。。完成
正在写入输出。。。[50%]指数
发生异常:
get_doctree中的文件“/usr/local/lib/python2.6/dist packages/Sphinx-1.1.3-py2.6.egg/Sphinx/environment.py”,第1213行
f=打开(doctree\u文件名’rb’)
IOError:[Errno 2]没有这样的文件或目录:’/home/ricomos/workspace/nextgen/docs/build/doctrees/index.doctree’
如果要向开发人员报告问题,则完整的回溯已保存在/tmp/sphinx-err-j7gm.log中。
如果是用户错误,也请报告,以便下次提供更好的错误消息。
将Bug发送到邮件列表(<;http://groups.google.com/group/sphinx-dev/>,
或在跟踪器at<;http://bitbucket.org/birkenfeld/sphinx/issues/>. 谢谢
我对斯芬克斯是一个完全的新手,对这类文档也比较陌生。有人能提供一些建议吗
编辑:
我希望能够使用Makefile来处理这个问题。到目前为止,我的项目中有两个文件夹
nextgen/ls
docs ys_utils
我需要nextgen/docs/Makefile为ys_-utils和所有其他模块生成HTML
Autodoc找不到您的模块,因为它们不在sys.path中
您必须在conf.py中的sys.path中包含模块的路径。
查看conf.py(在导入sys之后)的顶部,有一个sys.path.insert()语句,您可以对其进行调整
顺便说一下:您可以使用Sphinx创建的Makefile来创建文档。
就打电话
make
查看选项
如果在尝试之前出现问题:
清洁
在运行之前,生成html