隐藏toctree中的特定文件?

问题描述 投票:3回答:1

我正在本地主机上使用readthedocs.org实例从github repo构建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:,但它只是隐藏了所有内容。

我研究了尽可能多的文档,但是当这两个选项一起使用时,我找不到任何示例。

任何想法如何实现这一目标?

python-sphinx glob restructuredtext toctree
1个回答
2
投票

我不是狮身人面像的新手,所以也许这是可怕的狮身人面像礼节,但是我发现这给出了想要的行为而没有任何警告:

.. toctree::
  :glob:

  dir_to_glob/*

.. toctree::
  :hidden:

  dir_to_glob/file_to_hide

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

© www.soinside.com 2019 - 2024. All rights reserved.