Pokrycie sfinksa generuje pusty plik python.txt

Question

Używam Sphinx do udokumentowania mojego projektu. Włączyłem rozszerzenie sphinx.ext.coverage w moim pliku konfiguracyjnym. Biegnę następujące polecenie, aby wygenerować raport pokrycia (jak kierować 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. 

Jeśli patrzę wewnątrz _build/WYDAJNOŚĆ/python.txt, wszystko co widzę to:

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

ten nie ma rację, ponieważ na pewno są części mojego projektu, które nie są udokumentowane.

Ktoś posted o tym na liście dyskusyjnej sfinksa, ale nie otrzymuję żadnych odpowiedzi.

Czy ktoś wie, na czym polega problem? Jak mogę to naprawić?

Answer 1

Jedna rzecz do rozważenia - jeśli używasz :undoc-members:, będą one uważane za udokumentowane, mimo że są niczym więcej niż skrótem. To właśnie powodowało, że nie osiągałem żadnych rezultatów.

Answer 2

Jeśli funkcja ma docstring ale jest określony w części „Spis treści” z pliku .rst, to nadal będzie traktowane jako „pokryta” przez producenta pokrycia, a nie stać w python.txt