如何使用 RST 和 Sphinx 包含文件目录答案

【问题标题】：How to include a directory of files with RST and Sphinx如何使用 RST 和 Sphinx 包含文件目录
【发布时间】：2016-05-02 23:30:05
【问题描述】：

我正在尝试编写文档并希望并拥有多个目录树使用的多个文件。以前我使用带有.. include:: <isonum.txt> 的空文件，但是，这不适用于包含子目录的目录中的多个文件。我使用的另一个解决方案是使用我要链接到的索引文件的相对文件路径。然而，这弄乱了狮身人面像导航树。所以我的问题是如何包含 RST 和 Sphinx 的文件目录？

【问题讨论】：

请查看URL这将有助于提升您的内容质量
你可能想看看my solution，因为我需要类似的东西。基本上，生成（手动或自动）单个文件（例如include.rst），每个文件包含一个.. include:: 指令。然后，您只需要在源文件中包含这个唯一的文件。

标签： python-sphinx restructuredtext

【解决方案1】：

很遗憾，这无法完成。

toctree 指令有一个 glob 选项，您可以像这样使用它：

.. toctree::
   :glob:

   generated/*

但此选项在 include 指令中不可用。

也许会为它开始一个问题？

【讨论】：

【解决方案2】：

也许可以用注释（.. START_GLOB_INCLUDE 等）指示文件所在部分的开始和结束，然后有一个构建预处理步骤来查找您想要的文件并重写主文件的该部分.

【讨论】：