2016-05-31 9 views
5

私はreSTファイル内の別のドキュメントにどうやってリンクすることができるのか分かりません。ドキュメント内の別のreSTファイルをリンク/参照するにはどうしたらいいですか?

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

私は安心して構文を調べることができる素晴らしいリソースを参照してください。デフォルトのクイックスタートはちょっと退屈で、スフィンクスで休憩を使うことについての深い議論は含まれていません。

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

+0

http://www.sphinx-doc.org/en/stable/markup/inline.html#ref-role – mzjn

+0

@mzjnしたがって、install.rstという名前の2番目のファイルの先頭にマーカーを配置する必要があります'? –

答えて

0

私はconf.pyに次のものが含まれなければならなかった他のファイルをreferecnceするには。私は枕の文書(PILフォーク)hereからコードを取った。

extensions = ['sphinx.ext.intersphinx'] 

私はスフィア間の拡張が私の助けになったと思います。それは他のドキュメントページにもリンクしています。

+8

他の文書へのリンクをどのように記述してくださいかをご記入ください。 –

5

異なるreStructuredText(.rst)ファイル間のリンクを作成するには、sphinxが提供するインラインマークアップを使用します。ファイルの先頭に見出しクロスリファレンスドキュメント

See the documentationあなたはそのラベルを定義

.. _my-reference-label: 

あなたは

:doc:`my-reference-label`. 

を使用して、他の文書からそれにリンクすることができ、私はしないでください異なるプロジェクト間のリンクであるため、あなたはintersphinx拡張を使用する必要があると考えています。この方法では、上記のドキュメントのリンクで説明したように、相対パスを使用してさまざまな.rstファイルをリンクできます。

関連する問題