web-dev-qa-db-ja.com

ドキュメント内の別のreSTファイルをリンク/参照するにはどうすればよいですか?

ReSTファイル内の別のドキュメントにどのようにリンクできるのか、まったくわかりません。

install.rstという名前のファイルを、クイックスタートガイドの段落にリンクします。どうすればこれを達成できるかわかりません。

残りの構文を調べることができる素晴らしいリソースも参照してください。デフォルトのクイックスタートは少し退屈で、sphinxでの残りの使用についての詳細な説明は含まれていません。

問題のドキュメントは次のとおりです。 http://todx.rtfd.io

31
Aditya ultra

異なるreStructuredText(.rst)ファイル間のリンクを作成するには、sphinxが提供するインラインマークアップを使用できます。 ドキュメントを参照 見出しの下相互参照ドキュメント

ファイルの上に、ラベルを定義します

.. _my-reference-label:

次に、他のドキュメントからそれにリンクすることができます

:ref:`my-reference-label`.

Intersphinx拡張機能は異なるプロジェクト間のリンク用であるため、使用する必要はないと思います。この方法では、上記のドキュメントリンクで説明されているように、相対パスを使用して異なる.rstファイル間をリンクできます。

26

これを使用して別のドキュメントへのリンクを作成します。

:doc:`my document <../my_doc>` 

../my_docは、my_doc.rstファイルへのパスです。

conf.pyファイルにinter-sphinx拡張もあります。

extensions = ['sphinx.ext.intersphinx']
20
Eme Eme

@ eme-emeの答えを簡略化して、次のことができます。

:doc:`path/to/document`

パスを<>で囲み、表示するテキストを指定する必要はありません。この場合、参照されたドキュメントのトップレベルのヘッダーがリンクとして表示されます。

そのためにスフィンクス間拡張機能は必要ありません。

2
michcio1234