Domains用語集ChangelogSphinxを使用しているプロジェクトロール¶Sphinxは解釈済みのテキストのロールというものを使用して、用語の意味を記述して、リンクを張ったりできます。いうフォーマットで記述します。注釈デフォルトのロール(`content`)は標準では特別な意味を持っていません。必要に応じてどのように使用してもかまいません。変数名として使用する、などです。設定すれば、デフォルトのロールに対して、既存のロールを指定できます。ロールによるPythonオブジェクトを見つけられるため、デフォルトロールに設定するのに非常に有用です。instead.Math¶:math:¶インラインの数式のロールです。以下のロールは、テキストのスタイルを変更する以外には特別なことはしません。言葉の短縮形を書くのに使用します。ロールの中身として、括弧付き表現が含まれていた場合には特別扱いされます。HTMLではツールチップとして使用され、LaTeXでは一度だけ出力されます。ような、OSレベルのコマンドの名前に使用します。rm:dfn:¶テキスト中の用語の定義を書くのに使用します。インデックスエントリーは作成されません。mode:file:¶ファイルやディレクトリの名前に使用します。ロールのコンテンツ部分には波括弧を使って"変数"を表すことができます。マイナーバージョンに置き換えられることを示すよう、強調表示されます。その他のコンソール用ライブラリを使用したテキストベースのインタフェースにも使用します。ボタンやウィンドウのタイトル、フィールド名、メニュー、やメニューの項目名、リスト中の選択された値など、インタフェース上に表示されるラベルには、このロールを使用すべきです。ロールを使用すべきです。これはメニュー操作の手順をマークアップするのに使用します。メニューにはメニュー選択、サブメニュー選択、特定の操作での選択や、さらに細かいサブ操作などを含みます。使用して分割すべきです。Programsもし、選択したメニューにはオペレーティングシステム固有のコマンドの指示などが含まれていた場合には、これは省略すべきです。ダイアログを開くコマンドなどです。このようなコマンドの指示は選択名からは省きます。アンパサンドを利用したアクセラレータの表示に対応しています。:mimetype:¶MIMEタイプの名前、もしくはの一部MIMEタイプ(メジャー、マイナー部分、もしくは単独)を表します。text/plain:newsgroup:¶USENETのニュースグループ名です。実行プログラムの名前です。これはプラットフォームによって名前が変化することもあります。それ以外の拡張子はは省略すべきです。引用符は含めることはできません。下記のロールは外部へのリンクを生成します。8.1.:pep:¶Python拡張提案書(PEP)への参照です。これは適切なインデックスのエントリーを作成します。number"という形式のテキストが作成されます。HTML出力ではこのテキストは特定のPEPのオンラインのコピーへのハイパーリンクとなります。8:rfc:¶インターネットのRFCへの参照です。これは適切なインデックスのエントリーを作成します。number"という形式のテキストが作成されます。HTML出力ではこのテキストは特定のRFCのオンラインのコピーへのハイパーリンクとなります。file.|release|ドキュメントが参照しているプロジェクトのリリースと置き換えられます。candidateタグも含めた完全なバージョン文字列と置換されます。|version|ドキュメントが参照しているプロジェクトのリリースと置き換えられます。これは、メジャーバージョン、マイナーバージョンの定義部分のみを含む文字列です。