標準網域¶
版本 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 新增。
還有一個非常通用的物件描述指令，不與任何網域綁定