4

我在本地主机上使用readthedocs.org实例从我的github存储库构建 HTML 文档，我希望能够执行以下操作。

目前，我有一个使用 toctree 的 glob 功能读取的文件列表，如下所示：

.. toctree::
    :maxdepth: 2
    :glob:

     *

但我需要避免在我的目录中列出某些文件，例如：

Test_Manuals.rst
Test_Process.rst
Test_Users.rst
Testing.rst       <--- Only this file should appear in the toctree, all others are listed inside this one 
Testing_on_test_dot_spy.rst

我尝试:hidden:在该部分下方添加一个，:glob:但它只是隐藏了所有内容。

我已经查看了我能找到的尽可能多的文档，但是当这两个选项一起使用时，我没有找到一个例子。

知道如何实现这一目标吗？

4

1 回答 1

3

我对 Sphinx 比较陌生，所以也许这是可怕的 Sphinx 礼仪，但我发现这给出了预期的行为而没有任何警告：

.. toctree::
  :glob:

  dir_to_glob/*

.. toctree::
  :hidden:

  dir_to_glob/file_to_hide

投入一秒钟toctree似乎会覆盖如何处理file_to_hide而不会弄乱全局中的任何东西。这样，您只需要维护一个“排除”列表（对我来说它很小，听起来也可能适用于您的情况。）

于 2014-12-09T19:21:34.793 回答