Sphinx logo

前のトピックへ

sphinx.ext.ifconfig – 設定にしたがってコンテンツをON/OFFする

次のトピックへ

sphinx.ext.todo – Todoアイテムのサポート

このページ

 .. sphinx.ext.coverage – Collect doc coverage stats

sphinx.ext.coverage – ドキュメントのカバレッジの状況を収集します

この拡張機能には CoverageBuilder という追加のビルダーが一つ含まれます。

class sphinx.ext.coverage.CoverageBuilder
このビルダーを使用するには、coverage拡張を設定ファイルに登録して使用できるようにしたあとで、コマンドラインのオプションとして -b coverage を渡してください。

Todo

Write this section.

ビルダーがチェックすべきものを決定するための、いくつかの新しい設定値も追加されます:

coverage_ignore_modules
coverage_ignore_functions
coverage_ignore_classes
coverage_c_path
coverage_c_regexes
coverage_ignore_c_items