環境収集器API¶
-
class
sphinx.environment.collectors.EnvironmentCollector[ソース]¶ 環境収集器は、各文書内の特定のデータ収集器である。
データを集めて保存しています
BuildEnvironmentデータベースとしています特定のデータの例は、画像、ダウンロードファイル、チャプタタイトル、メタデータ、インデックス項目、およびディレクトリツリーなどであってもよい。-
clear_doc(app: Sphinx, env: sphinx.environment.BuildEnvironment, docname: str) → None[ソース]¶ 文書の指定データを削除する.
この方法は，文書を削除する際に呼び出される.
-
get_outdated_docs(app: Sphinx, env: sphinx.environment.BuildEnvironment, added: Set[str], changed: Set[str], removed: Set[str]) → List[str][ソース]¶ 読み直す文書名リストを返す.
このメソッドは，文書を読み込む前に呼び出される.
-
get_updated_docs(app: Sphinx, env: sphinx.environment.BuildEnvironment) → List[str][ソース]¶ 読み直す文書名リストを返す.
この方法は，文書全体(実験的)を読んで呼び出される.
-
merge_other(app: Sphinx, env: sphinx.environment.BuildEnvironment, docnames: Set[str], other: sphinx.environment.BuildEnvironment) → None[ソース]¶ 異なる文書からの文書名に関する指定データに統合する BuildEnvironment オブジェクト，これらのオブジェクトは並列生成中の子プロセスからのものである.
-