标准域¶
在版本 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(一个数字)- 默认值:
- 42
这是一个控制答案值的设置。
- .. 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 中加入。
还有一个非常通用的对象描述指令，它不与任何域绑定