标准域

在 1.0 版本加入.

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

使用 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.

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

在 5.3 版本发生变更: 可以交叉引用包括选项值： :option:`--module=foobar`， :option:`--module[=foobar]` 或 :option:`--module foobar`。

使用 option_emphasise_placeholders 来解析文字文本的“可变部分”（类似于 samp 角色）。

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

.. confval:: name

在 7.4 版本加入.

描述文档化代码或程序使用或定义的配置值或设置。可引用者 confval。

:type: (text)

描述配置值的类型。这是可选的，如果指定将被解释为 reStructuredText。

:default: (text)

描述配置值的默认值。这是可选的，如果指定将被解释为 reStructuredText。

举例如下：

.. confval:: the_answer
   :type: ``int`` (a *number*)
   :default: **42**

   This is a setting that controls the value of the answer.

将呈现如下：

the_answer

类型:

int (a number)

默认:

42

这是一个控制答案值的设置。

.. envvar:: name

描述文档化代码或程序使用或定义的环境变量。可引用者 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.

然后 :option:`rm -r` 将引用第一个选项，而 :option:`svn -r` 将引用第二个选项。

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

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

在 0.5 版本加入.

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

.. describe:: text

.. object:: text

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

.. describe:: PAPER

   You can set this variable to select a paper size.

Previous

域

Next

C域