Sphinx coverage会生成空的python.txt文件

时间:2014-10-24 09:24:19

标签: python python-sphinx

我使用Sphinx来记录我的项目。我在配置文件中启用了sphinx.ext.coverage扩展名。我运行以下命令来生成覆盖率报告(由this answer指导:

bash-3.2$ sphinx-build -v -b coverage . _build/coverage/
Making output directory...
Running Sphinx v1.2.3
loading pickled environment... not yet created
building [coverage]: coverage overview
updating environment: 10 added, 0 changed, 0 removed
...
reading sources... [100%] modules
looking for now-outdated files... none found
pickling environment... done
checking consistency... /some/path/modules.rst:: WARNING: document isn't included in any toctree
done
build succeeded, 17 warnings.

如果我查看_build / coverage / python.txt,我看到的只有:

Undocumented Python objects
===========================

这不是很正确,因为我的项目中肯定有部分内容没有记录。

有人posted在sphinx邮件列表中有关此事,但没有得到任何回复。

有人知道问题是什么吗?我该如何解决?

2 个答案:

答案 0 :(得分:7)

要考虑的一件事 - 如果您使用:undoc-members:,它们将被视为文档,即使它们只不过是存根。这是导致我没有结果的原因。

答案 1 :(得分:3)

如果你的函数没有文档字符串但是在你的.rst文件的'contents'部分中指定,那么它仍然会被覆盖构建器视为'覆盖',而不是在你的python.txt中