警告

この記事は古い為 sphinx-users.jp を参照してください。

第11日目 Sphinxドキュメントを編集する その8

昨日は外部リンクの張り方を説明しました。今日は プロジェクト 内へのリンクを説明します。

ドキュメントへのリンク

  • 他のドキュメント( rstファイル )へリンクを張りたい時は :doc: というマークアップをします。

    記述例:

    昨日のタイトルは :doc:`write_rest7` です。一昨日は :doc:`toctree <write_rest6>` について説明しましたね。
    

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

    昨日のタイトルは 第10日目 Sphinxドキュメントを編集する その7 です。一昨日は toctree について説明しましたね。

  • ファイルへのパスは拡張子が不要です。

  • ファイルパスはドキュメントの起点となる index.rst/ (ルート) とした絶対パスか、相対パスで記述して下さい。

Comments

comments powered by Disqus