python-sphinx - 从 toctree 隐藏特定文件？

Question

我正在本地主机上使用 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

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

我已经研究了尽可能多的文档，但没有找到这两个选项一起使用的示例。

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

Answer 1

我对 Sphinx 比较陌生，所以这也许是糟糕的 Sphinx 礼仪，但我发现这在没有任何警告的情况下给出了所需的行为:

.. toctree::
  :glob:

  dir_to_glob/*

.. toctree::
  :hidden:

  dir_to_glob/file_to_hide

添加第二个toctree似乎会覆盖如何处理file_to_hide，而不会弄乱全局中的任何内容。通过这种方式，您只需要维护一个“排除”列表(对我来说这个列表很小，听起来也可能适合您的情况。)