他のファイルを読み込みたい

include を使います。 include は読み込んだファイルもrstファイルとみなして対処します。

一方、 literalinclude はその名のとおり、literalとしてそのまま読み込まれます。

.. include:: 読み込むファイルパス
.. literalinclude:: 読み込むファイルパス

注意点として、 literalinclude はSphinxの拡張であり、reSTを解釈する他のシステムではない場合があります。また、 include ではファイルがないとエラーになりますが、 literalinclude は警告となります。

適用例

includeの例

orphan

これは読み込まれるためのファイルです。

include あるいは literarlinclude を使って読み込まれます。例としてあるだけなので、先頭で orphan を設定しています。

include であればソースコードもちゃんと判断してくれます。

import this

literalincludeの例

:orphan: 


これは読み込まれるためのファイルです。

``include`` あるいは ``literarlinclude`` を使って読み込まれます。例とし
てあるだけなので、先頭で ``orphan`` を設定しています。

``include`` であればソースコードもちゃんと判断してくれます。

.. code-block:: python

  import this