建置環境 API¶

class sphinx.environment.BuildEnvironment[原始碼]¶

屬性

每個文件的屬性

current_document¶

讀取文件時的暫時資料儲存。

擴充功能可以使用 env.current_document 提供的映射介面來儲存與目前文件相關的資料，但應使用唯一前綴以避免名稱衝突。

重要

只有以下屬性構成公開 API。類型本身和任何方法或其他屬性仍然是私有的、實驗性的，並且可能會在不另行通知的情況下更改或移除。

current_document.default_domain: Domain | None¶: 目前文件的預設網域。由 default-domain 指令設定。

current_document.highlight_language: str¶: 語法突顯的預設語言。由 highlight 指令設定，以覆寫 highlight_language 設定值。

current_document._parser: Parser | None¶

此屬性為實驗性質，可能會在不另行通知的情況下變更。

用於剖析目前文件的剖析器。

實用方法

doc2path(docname: str, base: bool = True) → _StrPath[原始碼]¶

傳回文件名稱的檔案名稱。

如果 base 為 True，則傳回 self.srcdir 下的絕對路徑。如果 base 為 False，則傳回相對於 self.srcdir 的路徑。

relfn2path(filename: str | Path, docname: str | None = None) → tuple[str, str][原始碼]¶

傳回從文件參考的檔案路徑，相對於文件根目錄和絕對路徑。

在輸入「filename」中，絕對檔案名稱被視為相對於原始碼目錄，而相對檔案名稱則相對於包含文件的目錄。

note_dependency(filename: str | PathLike[str], *, docname: str | None = None) → None[原始碼]¶

將 filename 新增為目前文件的相依性。

這表示如果此檔案變更，文件將會重建。

filename 應為絕對路徑或相對於原始碼目錄。

new_serialno(category: str = '') → int[原始碼]¶

傳回序號，例如用於索引項目目標。

該號碼保證在目前文件中是唯一的。