标准域¶

Added in version 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 ，，：选项：--模块 [=foobar] `或 `--module foobar` `。

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

cmdoption 指令是的不推荐使用的别名 option 指令。

.. 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 将引用第一个选项，而 `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.

Sphinx