標準ドメイン¶
バージョン 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¶
- Type:
int(a number)- Default:
- 42
これは、答えの値を制御する設定です。
- .. program:: name¶
py:currentmoduleと同様に、このディレクティブは出力を生成しません。代わりに、このディレクティブは、続くすべてのoptionディレクティブが、*name* という名前のプログラムのオプションをドキュメント化することを Sphinx に通知します。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`は 2 番目のオプションを参照します。Noneが引数に渡された場合、ディレクティブは現在のプログラム名をリセットします。プログラム名にはスペースを含めることができます (例:
svn addやsvn commitのようなサブコマンドを個別にドキュメント化する場合)。バージョン 0.5 で追加。
また、どのドメインにも結び付けられていない、非常に汎用的なオブジェクト記述ディレクティブもあります