python - Sphinx 是否在执行 'make html' 时运行我的代码？

Question

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

到目前为止一切顺利。但是，当我尝试使用命令 make html 创建 HTML 时，会弹出许多回溯，代码库中的一些示例似乎已被执行。这可能是什么原因，我该如何防止这种情况发生？

Answer 1

使用 autodoc 时, Sphinx 导入文档化模块，因此所有模块级代码都被执行。每次您“制作 html”时都会发生这种情况。从这个意义上讲，Sphinx 确实“运行”了您的代码。

您可能需要以不同方式组织代码以使错误消失(将模块级代码移至函数)。参见 this question举个可能发生的例子。

这是我的猜测，但可能不是全部。没有额外的信息很难说更多。