ドキュメントのネットワーク構造(リンクの張り方)

外部URLへのリンク

  • 一番単純なURLへのリンクの張り方は、単にURLを記述する事です。

    記述例:

    http://sphinx-users.jp/
    

    このように表示されます。

  • URLを見せずに文字列を見せたい場合は下記のように記述します。

    記述例:

    `sphinx <http://sphinx-users.jp/>`_
    

    このように表示されます。

    もし、同じリンクを使いまわしたい時は、

    まず ターゲット定義 を書く:

    .. _`sphinx`: http://sphinx-users.jp/
    

    記述例:

    この `sphinx`_ を会得すると、身も心も `sphinx`_ 化してしまい、 どんなドキュメントも `sphinx`_ にしないと気が済まなくなるらしい。
    

    このように表示されます。

    この sphinx を会得すると、身も心も sphinx 化してしまい、 どんなドキュメントも sphinx にしないと気が済まなくなるらしい。

Table Of Contents

Previous topic

ドキュメントを構造化する

Next topic

プロジェクト内へのリンク

This Page