4

文書化したいプロジェクトの構造は次のとおりです。

/top
Index.rst
     /a
     toctree_a.rst (contains doc and doc2)
     doc.rst
     doc2.rst
     /b
     toctree_b.rst (contains doc4 and doc3)
     doc3.rst
     doc4.rst

プロジェクトがプロジェクト ツリーで 4 つのドキュメントを参照できる toctreeように、サブディレクトリ (a と b) の sを参照したいと考えています。toctree

ドキュメントが 1 つのディレクトリにある場合はこれを行う方法を知っていますが、サブディレクトリにある場合はこれを行う方法がわかりません。すべてのファイルを 1 つのディレクトリに移動することなく、プロジェクトの構造をそのまま維持しようとしています。私はいくつかの調査を行い、それ .. include:: directiveが進むべき道である可能性があることを発見しましたが、それを適切に使用する方法を理解できませんでした.

4

1 に答える 1

7

index.rst の toctree に、次のようにサブディレクトリからファイルを取得するように指示できます。

コンテンツ：

.. toctree::
   :maxdepth: 2

    a/doc
    a/doc2
    b/doc3
    b/doc4

この方法は、同じディレクトリにある場合と同じように機能します

于 2016-09-01T08:56:17.237 に答える