環境コレクターAPI¶
- class sphinx.environment.collectors.EnvironmentCollector[ソース]¶
EnvironmentCollectorは、各ドキュメントからの特定のデータコレクターです。
データを収集し、
BuildEnvironmentをデータベースとして保存します。特定のデータの例としては、画像、ダウンロードファイル、セクションタイトル、メタデータ、インデックスエントリ、toctreesなどがあります。注釈
このクラスは、基本的にSphinxイベントコールバックのサブセットをラップします。
- clear_doc(app: Sphinx, env: BuildEnvironment, docname: str) None[ソース]¶
ドキュメントの指定されたデータを削除します。
このメソッドは、ドキュメントの削除時に呼び出されます。
- get_outdated_docs(app: Sphinx, env: BuildEnvironment, added: set[str], changed: set[str], removed: set[str]) list[str][ソース]¶
再読するドキュメント名のリストを返します。
このメソッドは、ドキュメントを読み込む前に呼び出されます。
- get_updated_docs(app: Sphinx, env: BuildEnvironment) list[str][ソース]¶
再読するドキュメント名のリストを返します。
このメソッドは、ドキュメント全体を読み込んだ後に呼び出されます。
- merge_other(app: Sphinx, env: BuildEnvironment, docnames: set[str], other: BuildEnvironment) None[ソース]¶
並列ビルドのサブプロセスから来た異なるBuildEnvironmentオブジェクトから、docnamesに関する指定されたデータをマージします。