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正規表現 のリスト。

これらの正規表現のいずれかが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

docstringが書かれておらず、ソースにドキュメントがないオブジェクトはスキップします。デフォルトは False です。

バージョン 1.1 で追加.

coverage_show_missing_items

欠落しているオブジェクトも標準出力に出力します。デフォルトでは False です。

バージョン 3.1 で追加.