Environment Collector API¶

class sphinx.environment.collectors.EnvironmentCollector[來源]¶

EnvironmentCollector 是從每個文件收集特定資料的收集器。

它收集資料並將 BuildEnvironment 儲存為資料庫。特定資料的範例可以是圖片、下載檔案、章節標題、中繼資料、索引條目和目錄樹等等。

注意

此類別本質上包裝了 Sphinx 事件回呼的子集。

clear_doc(app: Sphinx, env: BuildEnvironment, docname: str) → None[來源]¶

移除文件的指定資料。

當文件被移除時，會呼叫此方法。

另請參閱

env-purge-doc

get_outdated_docs(app: Sphinx, env: BuildEnvironment, added: set[str], changed: set[str], removed: set[str]) → list[str][來源]¶

傳回要重新讀取的文件名稱列表。

在讀取文件之前，會呼叫此方法。

另請參閱

env-get-outdated

get_updated_docs(app: Sphinx, env: BuildEnvironment) → list[str][來源]¶

傳回要重新讀取的文件名稱列表。

在讀取完整文件後，會呼叫此方法。

另請參閱

env-get-updated

merge_other(app: Sphinx, env: BuildEnvironment, docnames: Set[str], other: BuildEnvironment) → None[來源]¶: 合併來自不同 BuildEnvironment 物件的關於文件名稱的指定資料，該物件來自平行建置中的子程序。

另請參閱

env-merge-info

process_doc(app: Sphinx, doctree: nodes.document) → None[來源]¶

處理文件並從中收集特定資料。

在讀取文件後，會呼叫此方法。

另請參閱