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

Question

reST ファイル内の別のドキュメントにリンクする方法がわかりません。

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

残りの構文を検索できる優れたリソースも参照してください。デフォルトのクイックスタートは少し退屈で、sphinx での rest の使用に関する深い議論は含まれていません。

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

Answer 1

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

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

../my_docmy_doc.rst私のファイルへのパスです。

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

extensions = ['sphinx.ext.intersphinx']

Answer 2

@eme-emeの答えを単純化すると、次のことができます：

:doc:`path/to/document`

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

そのためにインタースフィンクス拡張は必要ありません。

Answer 3

他のファイルを参照するには、conf.py. ここで、Pillow(PIL fork) のドキュメントからコードを取得しました。

extensions = ['sphinx.ext.intersphinx']

スフィンクス間の拡張機能が役に立ったと思います。他のドキュメントページにリンクしています。