标准域

Added in version 1.0.

所谓的“标准”域收集所有不保证自己域名的标记。其指令和角色不以域名为前缀。

标准域也是使用:func:~sphinx.application.Sphinx.add_object_type API添加的自定义对象描述的位置。

有一组指令允许记录命令行程序：

.. option:: name args, name args, ...

描述命令行参数或开关。选项参数名称应括在尖括号中。例子：

.. option:: dest_dir

   Destination directory.

.. option:: -m <module>, --module <module>

   Run a module as a script.

该指令将为给定的选项创建交叉引用目标，可通过以下方式引用:rst:role:option （在示例中，您将使用类似“dest_dir”，“:option:-m`”， 或者“--module”)。

在 5.3 版本发生变更: One can cross-reference including an option value: :option:`--module=foobar`, ,``:option:–module[=foobar]`` or :option:`--module foobar`.

Use option_emphasise_placeholders for parsing of “variable part” of a literal text (similarly to the samp role).

“cmdoption”指令是“option”指令的弃用别名。

.. envvar:: name

描述文档化代码或程序使用或定义的环境变量。可引用者:rst:role:envvar。

.. program:: name

像 py:currentmodule，这个指令不产生输出。相反，它用于通知Sphinx所有以下内容 option 指令文件选项称为*name*。

如果你使用 program，你必须通过程序名来限定你的 option 角色中的引用，所以如果你有以下情况：

.. program:: rm

.. option:: -r

   Work recursively.

.. program:: svn

.. option:: -r <revision>

   Specify the revision to work upon.

然后“rm -r”将引用第一个选项，而“svn -r”将引用第二个选项。

如果 None 被传递给参数，该指令将重置当前的程序名称。

程序名称可能包含空格（如果你想分别记录“svn add”和“svn commit”这样的子命令）。

Added in version 0.5.

还有一个非常通用的对象描述指令，它不依赖于任何域：

.. describe:: text

.. object:: text

此伪指令生成与域提供的特定格式相同的格式，但不创建索引条目或交叉引用目标。例：

.. describe:: PAPER

   You can set this variable to select a paper size.