标准域

版本 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

描述记录的代码或程序使用的或定义的配置值或设置。可以通过 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 (一个数字)

默认值:

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 域