sphinx.ext.coverage --文書カバー率統計情報の収集

この拡張には追加の構築器があります CoverageBuilder それがそうです。

class sphinx.ext.coverage.CoverageBuilder

このビルダを使用するためには、構成ファイルでCoverage拡張をアクティブにして提供してください -b coverage 命令行にあります。

課題

この節を書いてください。

いくつかの構成値を使用して、ビルダがチェックすべき内容を指定することができる：

coverage_ignore_modules

coverage_ignore_functions

coverage_ignore_classes

coverage_ignore_pyobjects

明細書 Python regular expressions それがそうです。

これらの正規表現のいずれかがPythonオブジェクトの完全なインポートパスの任意の部分に一致する場合、Pythonオブジェクトは文書カバー率レポートから除外されます。

バージョン 2.1 で追加.

coverage_c_path

coverage_c_regexes

coverage_ignore_c_items

coverage_write_headline

とする. False 最初のニュースは書きません。

バージョン 1.1 で追加.

coverage_skip_undoc_in_source

文書文字列を用いてソースコードに記録されていないオブジェクトをスキップする. False デフォルトの場合。

バージョン 1.1 で追加.

coverage_show_missing_items

また、欠落したオブジェクトを標準出力に印刷することもできる。 False デフォルトの場合。

バージョン 3.1 で追加.