标准域¶
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(in在示例情况下,您会使用类似的内容:option:`dest_dir, `-m`',或者:option:`--module`).在 5.3 版本发生变更: 可以交叉引用,包括期权值:
:option:`--module=foobar',':选项:'--模块 [=foobar] '或者:option:`--module foobar`.使用
option_emphasise_placeholders用于解析文本的“变量部分”(类似于samp角色)。cmdoption指令是option指令。
- .. confval:: name¶
Added in version 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
这是控制答案值的设置。
- .. 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单独)。Added in version 0.5.
还有一个非常通用的对象描述指令,它不绑定到任何域: