7

我正在使用出色的 Sphinx 工具来创建一些文档,并且我试图通过将同一部分的章节分成单独的文件来保持代码库的模块化形式。(有关“章节”和“部分”的定义,请参见此处。

我尝试使用两个文件来做到这一点test1.rst

######
Part 1
######

*********
Chapter 1
*********

Section 1
=========
Test Content 1.

test2.rst

*********
Chapter 2
*********

Section 2
=========
Test Content 2.

它们包含在index.rst这样的范围内:

.. toctree::
   :maxdepth: 2

   test1
   test2

但是,在构建时,第 2 章不会嵌套在第 1 部分中。这是为什么呢?有没有办法做到这一点,而不必创建一个脚本来将它们附加到一个文件中,如下例所示?

例子:

######
Part 1
######

*********
Chapter 1
*********

Section 1
=========
Test Content 1.

*********
Chapter 2
*********

Section 2
=========
Test Content 2.
4

1 回答 1

8

看起来该include指令就是您正在寻找的。包含文件的内容在指令点被解析和包含。

测试1.rst:

######
Part 1
######

*********
Chapter 1
*********

Section 1
=========
Test Content 1.

.. include:: test2.rst
于 2017-10-18T07:02:14.383 回答