我正在使用出色的 Sphinx 工具来创建一些文档,并且我试图通过将同一部分的章节分成单独的文件来保持代码库的模块化形式。 (请参阅此处了解“章节”和“部分”的定义。 http://www.sphinx-doc.org/en/stable/rest.html#sections)
我尝试使用两个文件来做到这一点,test1.rst
:
######
Part 1
######
*********
Chapter 1
*********
Section 1
=========
Test Content 1.
and 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 http://docutils.sourceforge.net/docs/ref/rst/directives.html#include指令就是您正在寻找的内容。包含文件的内容在指令处被解析并包含。
测试1.rst:
######
Part 1
######
*********
Chapter 1
*********
Section 1
=========
Test Content 1.
.. include:: test2.rst
本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系:hwhale#tublm.com(使用前将#替换为@)