2016-08-10 15 views
1

は、私が言うことができるexamplesディレクトリ、彼らはコードだと、彼らはコードとして正しくフォーマットしているので、素晴らしい作品..which別のドキュメントにドキュメントを含めるためのsphinxディレクティブは何ですか?私のドキュメントで

.. literalinclude:: examples/1_basic_usage.py 
    :language: python 
    :linenos: 

を持っています。

ただし、非コード文書でliteralincludeを実行したいとします。プロジェクト全体のレベルで私はすでにAUTHORSDESCRIPTIONATTRIBUTIONなどが定義されていて、(本質的に)それらをインプレースに貼り付けたいのですが、どうすればよいかわかりません。

うまくいけば、それはこのNON WORKING例に似ています:

Authors 
------- 
.. literalinclude:: ../../AUTHORS 

Attribution 
----------- 
.. literalinclude:: ../../ATTRIBUTION 

答えて

1

どうやらこれを行う方法は.. include:: <path>ディレクティブです。

ドキュメントには明白ではなく、スタブの例もありません。

フルドキュメントは、docutils reStructuredText reference (#include)にあります。

"include"指示文は、テキストファイルを読み込みます。ディレクティブ引数は、ディレクティブを含むドキュメントを基準にして、含まれるファイルへのパスです。リテラルまたはコードのオプションが指定されていない限り、ファイルは指示文の時点で現在のドキュメントのコンテキストで解析されます。例:

この最初の例はドキュメントレベルで解析され、 にはセクションヘッダーを含む任意の構文が含まれます。

.. include:: inclusion.txt 

Back in the main document. 

    This second example will be parsed in a block quote context. 
    Therefore it may only contain body elements. It may not 
    contain section headers. 

    .. include:: inclusion.txt 
関連する問題