リンク¶
URL¶
ドキュメント内に URL を記述すると、そのままリンクになります。
Sphinx 日本ユーザー会のサイトは https://sphinx-users.jp/index.html です。
Sphinx 日本ユーザー会のサイトは https://sphinx-users.jp/index.html です。
URL 部分をリンクテキストに変更できます。
Sphinx 日本ユーザー会のサイトは `ここをクリック <https://sphinx-users.jp/index.html>`_ します。
Sphinx 日本ユーザー会のサイトは ここをクリック します。
rst ファイル¶
docを使用してrstファイルにリンクを設定します。
Sphinx の文書構造の説明は「 :doc:`../struct/struct` 」で確認してください。
Sphinx の文書構造の説明は「 文書の構造 」で確認してください。
リンク先の
rstファイルを<と>でくくって指定すると、表示する文字列を任意のものに置き換えられます。
Sphinx の文書構造の説明は :doc:`こちらを確認 <../struct/struct>` してください。
Sphinx の文書構造の説明は こちらを確認 してください。
ラベル¶
文書内にラベルを埋め込み、そのラベルに対してリンクを設定します。
ラベルは Sphinx の文書内でユニークでなければなりません。
ラベルは見出しとセットで設定します。
リンク先のドキュメントです。見出しの前にラベルを設定します。
.. _struct-toctree-split:
ドキュメントの分割
----------------------------------------------------------------------------------------------------
「 :ref:`struct-contents` 」のように 1 つの ``rst`` ファイルに複数の「部」や「章」などを書いてもドキュメントは作成できます。しかし、この方法ではページのサイズが長くなり、視認性や検索性、メンテナンス性などに劣るドキュメントになります。
refを使用してラベルにリンクを設定します。
ドキュメントを分割するときの考え方は「 :ref:`struct-toctree-split` 」を参照してください。
ドキュメントを分割するときの考え方は「 ドキュメントの分割 」を参照してください。
リンク先のラベルを
<と>でくくって指定すると、表示する文字列を任意のものに置き換えられます。
ドキュメントを分割するときの考え方は :ref:`こちらを参照<struct-toctree-split>` してください。
ドキュメントを分割するときの考え方は こちらを参照 してください。