sphinx.ext.extlinks --外部リンクのタグを短縮する

モジュールの作者: Georg Brandl

バージョン 1.0 で追加.

この拡張は、bugトラッカ、バージョン制御Webインターフェース、または他のウェブサイト内のサブページへのリンクのような同じサイト上のURLを指す多くの外部リンクがあるという一般的なモードを解決することを目的としている。これは，リンクを作成する際にサブページ名を与えるだけでよいように，基本URLに別名を提供することで実現される.

Sphinxトラッカには問題へのリンクが多く含まれていたいと仮定し，アドレスは https://github.com/sphinx-doc/sphinx/issues/{num} それがそうです。このURLを何度も入力するのは煩雑ですので、ご利用いただけます extlinks 同じ過ちを繰り返さないようにする。

この拡張は、構成値を追加します。

extlinks

この配置値は外部サイトの辞書でなければならず，唯一の短いエイリアスを基本URL和にマッピングする. 接頭辞. それがそうです。例えば、上記の問題の別名を作成するためには、追加する必要があります：

extlinks = {'issue': ('https://github.com/sphinx-doc/sphinx/issues/%s',
                      'issue ')}

今では、例えば新しいキャラクターとして別名を使うことができます :issue:`123 .そして、これは、https：//github.com/sphinx-doc/sphinx/Issues/123へのリンクを挿入する。ご覧のように、ロールに与えられたターゲットは、基本URLで置換されています ``%s` それがそうです。

このリンクは 説明する. タプルの第2の項に依存します 接頭辞. ：

• 接頭辞が None リンクタイトルは完全なURLである.

• プレフィックスが空文字列である場合，リンクタイトルはロールコンテンツに与えられた部分URLである. (123 この場合は。)

• プレフィックスが非空文字列である場合、リンクヘッダは部分URLであり、プレフィックスを加える--上の例では、リンクタイトルは issue 123 それがそうです。

リンクを生成する他の役割サポートの一般的な“明示的タイトル”文法を使用することもできます。 :issue:`this issue <123> `.この場合には 接頭辞. 関係ありません。

注釈

リンクは読解段階のロールから生成されるため，たとえば通常のリンクの形で出現する. linkcheck 建築業者です。