詞彙表¶

建構器 (builder)¶

一個類別 (繼承自 Builder)，它接受解析過的文件並對其執行動作。通常，建構器將文件轉換為輸出格式，但也可能使用建構器來檢查文件中的斷鏈，或建立涵蓋範圍資訊。

請參閱建構器以取得 Sphinx 內建建構器的概觀。

設定目錄 (configuration directory)¶

包含 conf.py 的目錄。預設情況下，這與來源目錄相同，但可以使用 -c 命令列選項設定為不同的目錄。

指令 (directive)¶

reStructuredText 標記元素，允許標記具有特殊含義的內容區塊。指令不僅由 docutils 提供，Sphinx 和自訂擴充功能也可以新增自己的指令。基本指令語法如下所示

.. directive-name:: argument ...
   :option: value

   Content of the directive.

請參閱指令以取得更多資訊。

文件名稱 (document name)¶

由於 reStructuredText 來源檔案可以有不同的副檔名 (有些人喜歡 .txt，有些人喜歡 .rst – 副檔名可以使用 source_suffix 設定)，且不同的作業系統有不同的路徑分隔符號，Sphinx 將它們抽象化：文件名稱 始終相對於來源目錄，副檔名被移除，路徑分隔符號轉換為斜線。所有值、參數以及諸如此類引用「文件」的內容都預期使用此類文件名稱。

文件名稱的範例為 index、library/zipfile 或 reference/datamodel/types。請注意，沒有開頭或結尾的斜線。

領域 (domain)¶

領域是標記 (reStructuredText 指令和角色) 的集合，用於描述和連結到屬於一起的物件，例如程式語言的元素。領域中的指令和角色名稱具有類似 domain:name 的名稱，例如 py:function。

擁有領域意味著當一套文件想要引用 C++ 和 Python 類別時，不會出現命名問題。這也意味著支援完整新語言文件擴充功能更容易編寫。

有關更多資訊，請參閱領域。

環境 (environment)¶

一個結構，其中儲存了根目錄下所有文件的資訊，並用於交叉引用。環境在解析階段後被 pickle 序列化，以便後續執行僅需要讀取和解析新的和已變更的文件。

擴充功能 (extension)¶

自訂角色、指令或 Sphinx 的其他方面，允許使用者修改 Sphinx 內建流程的任何方面。

有關更多資訊，請參閱擴充功能。

主文件 (master document)¶

根文件 (root document)¶

包含根 toctree 指令的文件。

物件 (object)¶

Sphinx 文件的基本建構區塊。每個「物件指令」(例如 py:function 或 object) 都會建立這樣一個區塊；並且大多數物件都可以交叉引用。

RemoveInSphinxXXXWarning¶

警告的功能將在 Sphinx-XXX 版本中移除。這通常是由於使用了已棄用的 Sphinx 擴充功能所導致。另請參閱棄用警告。

角色 (role)¶

reStructuredText 標記元素，允許標記一段文字。與指令類似，角色是可擴充的。基本語法如下所示：:rolename:`content`。請參閱行內標記以取得詳細資訊。

來源目錄 (source directory)¶

目錄，包括其子目錄，包含一個 Sphinx 專案的所有來源檔案。

reStructuredText¶

一個易於閱讀、所見即所得的純文字標記語法和解析器系統。