如何将单个部分中的 Sphinx 章节分成不同的文件?
How to separate Sphinx chapters within a single part into different files?
我正在使用出色的 Sphinx 工具创建一些文档,并且我试图通过将相同部分的章节分成不同的文件来保持代码库的模块化形式。 (See here for definitions of 'chapter' and 'part'.)
我尝试使用两个文件来做到这一点,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.
include
指令似乎就是您要查找的内容。包含文件的内容在指令点被解析和包含。
test1.rst:
######
Part 1
######
*********
Chapter 1
*********
Section 1
=========
Test Content 1.
.. include:: test2.rst
我正在使用出色的 Sphinx 工具创建一些文档,并且我试图通过将相同部分的章节分成不同的文件来保持代码库的模块化形式。 (See here for definitions of 'chapter' and 'part'.)
我尝试使用两个文件来做到这一点,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.
include
指令似乎就是您要查找的内容。包含文件的内容在指令点被解析和包含。
test1.rst:
######
Part 1
######
*********
Chapter 1
*********
Section 1
=========
Test Content 1.
.. include:: test2.rst