Sphinx-Users.jp

Python製ドキュメンテーションビルダー、Sphinxの日本ユーザ会

クイック検索

参照 (Internal Hyperlink) したい¶

同じ文書中の他の項や節を参照するには、Internal Hyperlinkを使います。

.. _sample:

---------------
定義
---------------

このように、章や節の上に記述して定義しておきます。別の場所から参照するには以下のように書きます。

------------
他の場所で
------------

参照は :ref:`sample` としても参照できますし、
:ref:`ほげほげ<sample>` として任意のテキストでも参照できます。

テキストを指定しない場合、参照先のセクションタイトルを自動的に挿入してくれます。また、この場合は <> をつけないことに気をつけてください。

また、定義する時にはアンダーバー( _ )を先頭に付けますが、参照する時にはこのアンダーバーは必要ありません。

適用例¶

参照は適用例としても参照できますし、ほげほげとして任意のテキストでも参照できます。

  • Sphinx リファレンスマニュアル
  • Docutils(reST) マニュアル
  • 早わかりreStructuredText
  • 索引

Table Of Contents

  • Sphinx技術情報
    • Sphinxをはじめよう
    • 逆引き辞典
    • Sphinxクックブック
    • ドキュメント資料集
    • Sphinxハッキングガイド
    • 発表資料
    • Sphinxの歴史
    • 外部リンク集
  • コミュニティ情報
    • Sphinx-Users.jp一問一答
    • ミッションステートメント
    • 参加するには?
    • 必要なスキルは?
    • コミュニケーション
    • イベント
    • sphinx-users.jp 会則
  • 活用事例
    • Sphinxを使用しているサイト
    • Sphinxテンプレート
    • Sphinxを使用して執筆された書籍

前のトピックへ

リンクを貼りたい

次のトピックへ

他のファイルを読み込みたい

このページ

  • ソースコードを表示
Tweets by sphinxjp

Sphinx-Users.jp

© Copyright 2010-2020, Sphinx-Users.jp.

Created using Sphinx 8.1.3.

Last updated on 6月 06, 2025.

Source repository.

前のトピックへ
リンクを貼りたい
次のトピックへ
他のファイルを読み込みたい