我继承了一个相当大的
代码库,我想为它创建html文档.由于它是用
Python编写的,所以我决定使用sphinx,因为
代码的
用户习惯于使用sphinx创建的python文档的设计和
功能.
我使用命令sphinx-apidoc
自动创建rst
文件.我将模块路径导入sys.path,以便sphinx可以找到
代码.
到现在为止还挺好.但是,当我尝试使用命令make html创建html时,会弹出许多回溯,并且代码库中的一些示例似乎已被执行.可能是什么原因以及如何防止这种情况发生？
使用
autodoc时,Sphinx会导入已记录的模块,因此会执行所有模块级
代码.每次你做“制作HTML”时都会发生这种情况.从这个意义上讲,Sphinx会“运行”你的
代码.
您可能必须以不同的方式组织代码以使错误消失(将模块级代码移动到函数).有关可能发生的情况的示例,请参见this question.
这是我的猜测,但可能不是整个故事.没有其他信息,很难说更多.
