Sphinx coverage генерирует пустой файл 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/покрытия/python.txt, я вижу это:

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

Это не совсем верно, так как есть определенно части моего проекта, которые не документированы.

Кто-то posted об этом в списке рассылки сфинкса, но не получил никакого ответа.

Кто-нибудь знает, в чем проблема? Как это исправить?

Answer 1

Одна вещь, которую следует учитывать - если вы используете :undoc-members:, они будут считаться задокументированными, хотя они являются не чем иным, как заглушкой. Это и заставило меня не иметь никаких результатов.

Answer 2

Если функция не имеет строки документации, но указана в части "оглавление вашего .rst файла, то он все равно будет считаться«покрыты»застройщиком покрытия, а не стоять в вашем python.txt