sphinx、buildbot(和代码覆盖)。它们如何集成?

4 投票
1 回答
2247 浏览
提问于 2025-04-16 12:54

我有一个不算小的Python包,历史也挺久了,里面的文档都是用文档字符串写的。在开发过程中,我们引入了buildbot,后来又用了Jenkins/Hudson。最近,我在我的buildbot.cfg文件里添加了一个sphinx的配置,这样可以从源代码中收集文档,并保持网页上的文档是最新的。

到目前为止,一切都很好:每次我提交一个更改,Jenkins就会负责全面检查这个包,生成一个非常详细的概述,并更新我们的文档网站。

我启用了一个sphinx的扩展:coverage,用于生成文档覆盖率报告,但目前还没有相关的文档。

我在buildbot生成的环境中运行sphinx,但似乎无法把覆盖率统计信息包含到sphinx生成的文档网站里!

有没有什么提示呢?

1 个回答

3

sphinx.ext.coverage 页面 上提到,如果你指定构建器 -b coverage,就会计算代码的覆盖率。

结果会生成一个名为 "python.txt" 的文件,这个文件是一个 ReST 格式的文件。接下来,你需要把它整合到你自己的文档中。

撰写回答