允许多次包含文档(使用不同的段号)
作者: felixvd创建于 2022年8月2日更新于 2026年9月15日
标签type:enhancement
这个问题可能是一个 x-y 问题,而且可能有更好的解决方案。让我先解释一下我要做的事情。 我想构建多个手册,其中包含共同的部分。假设有相同的安全警告的模块,例如。我希望在多个位置包含这些共同的部分,以便可以重复使用。然而,我一直在思考如何正确包含这些文件。 我的理解是, Sphinx 并不是为了在一个文件夹中创建多个手册而设计的(如 @tk0miya 在 这里 所指出的那样),但是复制内容是不好的, 这个 SO 问题 表明我的用例(以及困惑)并不罕见,而且人们已经提出了许多不同的解决方案。 我认为最好的解决方案是使用一个包含所有内容的单个源目录,以及包含一个 conf 文件的子目录,该文件声明了每个手册的顶级 index。然而,我意识到每个节点只能有一个节点编号,该编号将在任何包含该节点的位置中显示。对于被包含在多个位置的文件,其中一个编号通常会出错。 这里 是一个最小的示例,生成了以下输出:
内容来源: sphinx-doc/sphinx