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

Question

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

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
===========================

这是不对的,因为我的项目肯定有部分没有记录.

有人在sphinx邮件列表上发布了这个,但没有得到任何回复.

有谁知道问题是什么？我如何解决它？

Answer 1

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