詞彙表¶

建置器（builder）¶

A class (inheriting from Builder) that takes parsed documents and performs an action on them. Normally, builders translate the documents to an output format, but it is also possible to use builders that e.g. check for broken links in the documentation, or build coverage information.

See 建置器 for an overview over Sphinx's built-in builders.

組態目錄（configuration directory）¶

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

指示詞（directive）¶

一種 reStructuredText 標註元素，允許為內容區塊標標註特殊意義。指示詞不僅由 docutils 提供，Sphinx 和自訂擴充套件也可以增添自己的指示詞。基本指示詞語法如下所示：

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

   Content of the directive.

See 指示詞 for more information.

document name¶

Since reStructuredText source files can have different extensions (some people like .txt, some like .rst -- the extension can be configured with source_suffix) and different OSes have different path separators, Sphinx abstracts them: document names are always relative to the source directory, the extension is stripped, and path separators are converted to slashes. All values, parameters and such referring to "documents" expect such document names.

Examples for document names are index, library/zipfile, or reference/datamodel/types. Note that there is no leading or trailing slash.

領域（domain）¶

A domain is a collection of markup (reStructuredText directives and roles) to describe and link to objects belonging together, e.g. elements of a programming language. Directive and role names in a domain have names like domain:name, e.g. py:function.

Having domains means that there are no naming problems when one set of documentation wants to refer to e.g. C++ and Python classes. It also means that extensions that support the documentation of whole new languages are much easier to write.

更多資訊請參考領域。

環境（environment）¶

A structure where information about all documents under the root is saved, and used for cross-referencing. The environment is pickled after the parsing stage, so that successive runs only need to read and parse new and changed documents.

extension¶

A custom role, directive or other aspect of Sphinx that allows users to modify any aspect of the build process within Sphinx.

更多資訊請參考擴充套件。

master document¶

root document¶

The document that contains the root toctree directive.

物件（object）¶

The basic building block of Sphinx documentation. Every "object directive" (e.g. py:function or object) creates such a block; and most objects can be cross-referenced to.

RemoveInSphinxXXXWarning¶

The feature which is warned will be removed in Sphinx-XXX version. It usually caused from Sphinx extensions which is using deprecated. See also 棄用警告.

角色（role）¶

A reStructuredText markup element that allows marking a piece of text. Like directives, roles are extensible. The basic syntax looks like this: :rolename:`content`. See 內聯標註 for details.

來源目錄（source directory）¶

The directory which, including its subdirectories, contains all source files for one Sphinx project.

reStructuredText¶

An easy-to-read, what-you-see-is-what-you-get plaintext markup syntax and parser system.