次のトピックへディレクティブこのページソースコードを表示クイック検索ロール¶Sphinxは解釈済みのテキストのロールというものを使用して、用語の意味を記述して、リンクを張ったりできます。いうフォーマットで記述します。注釈デフォルトのロール(`content`)は標準では特別な意味を持っていません。必要に応じてどのように使用してもかまいません。変数名として使用する、などです。設定すれば、デフォルトのロールに対して、既存のロールを指定できます。ロールによるPythonオブジェクトを見つけられるため、デフォルトロールに設定するのに非常に有用です。domains.クロスリファレンス文法¶クロスリファレンスは、意味解釈済みのテキストロールから生成されます。いう形式で書くだけでクロスリファレンスを作成できます。指定されたタイプを持つリンクが作成されます。追加の補助機能がいくつかありますが、これはロールに対するクロスリファレンスの目的を増やすものになります。いうreSTのハイパーリンクに似た書き方をすると、タイトルと参照対象の両方を明示できます。指定すると、参照もハイパーリンクも作成されなくなります。付けられると、ターゲットの最後の項目だけがリンクテキストになります。これは全てのクロスリファレンスで動作するのではなく、ドメインでのみ動作します。アトリビュート(マウスを上に持って行ったときにツールチップとして表示されるテキスト)には、常に、完全な参照対象の名前が設定されます。追加.この便利なロールは、参照先ターゲットを自動的に探してくれます。して解釈できるか試してみます。searched.次に、使われている全てのドメインのオブジェクト(ターゲット)に参照できるか試します。ターゲットが各ドメインで何にマッチするかの判定は各ドメインに任されています。クラスにマッチします。ターゲットが見つからない、または複数のターゲットが見つかった場合、警告が出力されます。複数のターゲットが見つかった場合は"any"ではなく明示的にロールを指定してください。設定した場合、多くのマークアップを書かずにクロスリファレンスを書けるようになります。拡張とも連携して動作します。ローカルのドキュメントにクロスリファレンスのターゲットがなくても、intersphinxのインベントリからターゲットを探します。オブジェクトのクロスリファレンス¶これらのロールは、それぞれのドメインの中で説明されています。標準のreSTのラベルを使用して、ドキュメント内の自由な位置にクロスリファレンスを作成することもできます。このラベルがきちんと動作するためには、ドキュメント全体の中で重複したラベルを使用することはできません。ラベルはユニークである必要があります。ロールはセクションへのリンクを作成します。この機能はセクションと参照が異なるソースファイルにあるときに動作します。ディレクティブを使用して、キャプションを明示しているテーブルに対しても、同様の働きをします。セクションタイトルの前にないラベルに対しても参照することはできますが、タイトルを明示する必要があります。いう文法を使用します。参照ラベルはアンダースコアで始まる必要があります。ラベルを参照するときには、先頭のアンダースコアは取り除く必要があります(上の例を参照)。追加.ドキュメントに対して直接リンクを張る方法もあります。絶対/相対のどちらかの形式でドキュメント名を指定することで、特定のドキュメントに対してリンクを張ることができます。対するリンクとなります。対するリンクが作成されます。いう形式で、明示的にリンクテキストを指定できますが、もし明示的なリンクテキストが与えられなかった場合には指定されたドキュメントのタイトルがリンクテキストとなります。追加.:download:¶このロールは表示可能なreST形式ではなく、ソースツリーに存在するその他の形式のファイルへのリンクを張って、ファイルをダウンロードできるようにするときに使用します。始まる)の場合には、トップのソースディレクトリからの相対パスとして見られます。ファイルは出力ディレクトリにコピーされ、適切なリンクが生成されます。ロールもセクションを参照します。書くことでリンクテキストを書くことも出来ます。指定された図、表、コードブロック、セクションへの参照を作成します。ターゲットにはreSTのlabelを使用します。1.1"のようなリンクテキストを持つその図への参照が挿入されます。<my-figure>`)、キャプションは表示用のテキストとして使用されます。