Sphinx-Users.jp

Sphinx-Users.jp

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

  • Sphinx-Users.jp

  • リファレンスマニュアル

  • 索引

参照 (Internal Hyperlink) したい¶

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

.. _sample:

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

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

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

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

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

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

適用例¶

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

Sphinxリファレンス

目次

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

前のトピックへ

リンクを貼りたい

次のトピックへ

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

このページ

  • ソースコードを表示

Sphinx-Users.jp

© Copyright 2010, Sphinx-Users.jp.

このドキュメントは Sphinx 1.1.2 で生成しました。

Last updated on Apr 27, 2012.

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