在Sphinx中拆分源文档(即管理文件层次结构)

时间:2012-02-22 11:45:50

标签: python-sphinx restructuredtext

在Sphinx中拆分源文档的正确方法是什么?

我有一个大文件,我们称之为file1.rst,其结构如下:

Section 1
*********

Subsection 1
============

Subsection 2
============

Subsection 3
============

每个子部分都很长,源文件变得难以管理。我想将每个小节放在不同的源文件中。

我尝试使用include指令:

Section 1
*********
.. include:: subsection1.rst
.. include:: subsection2.rst
.. include:: subsection3.rst

但是它发出的警告是第1章中的标签在section1.rst中重复(不是这样,标签只在子文档中)。

或者,是否有可能更改TOC指令中的层次结构?

1 个答案:

答案 0 :(得分:6)

我正在回答我自己的问题(羞耻!),因为我终于理解了我的错误。

TOC,目录指令可以多次次使用。这将导致我正在寻找的层次结构。

我希望这对那些像我一样认为只能有一个TOC的人有所帮助。