sphinx:ハイパーリンク¶

sphinxのリンクの記述方法は二種類あります．ひとつは，すべてをrstファイルの文章中に埋め込んでしまうやり方，もうひとつは，リンクはリンクでまとめて書いて置き，必要に応じて呼び出すやり方です．

個人的には後者のやり方を好むのですが，毎回リンク先のページが異なる場合等には前者のほうが楽なのかもしれません．

このページでは上記2つのやり方と，ページ内リンクの書き方に関してメモして置きます．

外部リンク¶

外部リンクの基本的なやり方は文章中に以下のように記述します．

sphinx:

文章 `リンクテキスト <http://ターゲットURL>`_ 文章

この場合，呼び出しは毎回記述していかなくては行けません．それに対し，同一ページから同一のリンクを複数記述する場合は以下のように記述することも可能です．

sphinx:

文章 `キーワード`_ 文章。

.. _キーワード: http://example.com

ページ内リンクを考えた時には，リンク先が何者なのか（章別にリンクを貼りたいのか，文章自体にリンクを貼りたいのか，図にリンクを貼りたいのか等）によって記法が異なるようです．

各章別にリンクを貼りたい場合，その対象になるヘッダの直前にラベルを振ることになります．また，これを参照する場合, :ref:`ラベルの名前` と書きます．

sphinx:

.. _labelCap1:

クロスリファレンスのセクション
------------------------------

これはセクションのテキストです。

これはセクションそのものを参照します。

:ref:`labelCap1`

この記法は図や表を参照する際にも利用できます（イメージ的にはtex的な感じですね）．

ただし，図の場合はラベル付けの際，以下のように記述します．

sphinx:

.. _my-figure:

.. figure:: whatever

   図のキャプション

また，表の場合は以下の通りです．

sphinx:

.. _my-figure:

.. table:: whatever

   表のキャプション

現在作成している sphinx プロジェクト内でリンクを貼りたい場合, :doc: ロールを使用します.

sphinx:

これについては :doc:`ここ<参照先のパス>` を確認ください.

その他の内部リンクに関しては，自分で使う機会のあるときに記述を加えていきます．