2017-01-30 1 views
0

私はRSTフォーマットのドキュメントを書いていて、Sphinxを使ってHTMLを生成しています。RSTのテキストをSphinxドキュメントのために再利用

RSTファイルに段落を書き込んで、同じ段落内の別のRSTファイルに同じ段落を再利用したいと考えています。元の段落を変更すると、他のすべてのファイルで自動的に変更されるように、再利用が必要になります。これは、Sphinxを使用してHTMLを生成するときに参照されています。

これを行うためのRST構文はありますか?どんな助けもありがとうございます。

答えて

3

include directiveを使用できます。

は、基本的には、のために、あなたは次のように再利用したい段落参照:

Some text 

.. include:: /path/to/file_to_include.rst 

More text 

私たちの例では、file_to_include.rstの内容はIncluded textです。 スフィンクスが生成されます:あなたは(上記のリンク)のdocutilsのドキュメントで見ることができるように

Some text 

Included text 

More text 

を、必要に応じて行の範囲に含まれるテキストを制限するために、たとえば、オプションのセットを指定することができます。

+0

ありがとうございます!私は完全なテキストを追加して、スタートラインまたはエンドラインのどちらかに追加することもできます。しかし、範囲を表示するパラメータとしてスタートラインとエンドラインの両方を追加すると、表示されません。私が使用している構文は次のとおりです。.. include :: includedtext.rst :start-line:11 \t \t:end-line:14 – Ashwin

+0

これは問題なく動作します。問題を再現し、Sphinx/Docutilsのバージョンを提供できるサンプルプロジェクトにリンクできますか? 行番号を正しく指定していますか?行数は0から始まります。 'end-line'は含まれません。 –

+0

ありがとうございます! – Ashwin

関連する問題