sphinx是否在执行'make html'时运行我的代码？

Question

我继承了一个相当大的代码库,我想为它创建html文档.由于它是用Python编写的,所以我决定使用sphinx,因为代码的用户习惯于使用sphinx创建的python文档的设计和功能.我使用该命令sphinx-apidoc自动创建rst文件.我导入了模块路径,sys.path以便sphinx可以找到代码.

到现在为止还挺好.但是,当我尝试使用该命令创建html时make html,会弹出许多回溯,并且代码库中的一些示例似乎已被执行.可能是什么原因以及如何防止这种情况发生？

Answer 1

使用autodoc时,Sphinx会导入已记录的模块,因此会执行所有模块级代码.每次你做"制作HTML"时都会发生这种情况.从这个意义上讲,Sphinx会"运行"你的代码.

您可能必须以不同的方式组织代码以使错误消失(将模块级代码移动到函数).请参阅此问题以获取可能发生的情况的示例.

这是我的猜测,但可能不是整个故事.没有其他信息,很难说更多.