python - Sphinx 覆盖生成空的 python.txt 文件

Question

我正在使用 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 邮件列表上，但没有得到任何回复。

有人知道问题出在哪里吗？我该如何解决？

Answer 1

需要考虑的一件事 -- 如果您使用 :undoc-members:，它们将被视为已记录，即使它们只不过是一个 stub 。这就是导致我没有结果的原因。