Python sphinx 从目录树中隐藏特定文件?
我正在本地主机上使用readthedocs.org实例从我的github repo构建HTML文档,我希望能够做到以下几点 目前,我有一个使用toctree的glob功能读取的文件列表,如下所示:Python sphinx 从目录树中隐藏特定文件?,python-sphinx,glob,restructuredtext,toctree,Python Sphinx,Glob,Restructuredtext,Toctree,我正在本地主机上使用readthedocs.org实例从我的github repo构建HTML文档,我希望能够做到以下几点 目前,我有一个使用toctree的glob功能读取的文件列表,如下所示: .. toctree:: :maxdepth: 2 :glob: * 但我需要避免在我的toc中列出某些文件,例如: Test_Manuals.rst Test_Process.rst Test_Users.rst Testing.rst <--- On
.. toctree::
:maxdepth: 2
:glob:
*
但我需要避免在我的toc中列出某些文件,例如:
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
Test\u Manuals.rst
测试过程
Test_Users.rst
Testing.rst我对狮身人面像比较陌生,所以这可能是可怕的狮身人面像礼仪,但我发现这在没有任何警告的情况下给出了所需的行为:
.. toctree::
:glob:
dir_to_glob/*
.. toctree::
:hidden:
dir_to_glob/file_to_hide
第二个目录树
似乎覆盖了如何处理文件以隐藏
,而不会搞乱全局。这样,您只需要维护一个“排除”列表(对我来说,这个列表很小,听起来可能也适用于您的情况。)您是否可以手动简化contstruct目录而不是使用*?在最坏的情况下,您需要编写一个自定义脚本片段来输出.rst本身:(我想允许开发人员在github中编辑文档,而不必担心目录树。它应该使用:glob:来索引所有可用文件,但我想隐藏一些特定的文件。在这种情况下,维护手动文档树是最简单的选项。这在我的场景中不起作用:我的顶级目录树位于索引中。rst
包含foo
,一个dfoo.rst
中有两个目录树。当我创建html时,index.html
显示其目录树,它包含完整通配符中的所有内容,而不是通配符减去细节。编辑:首先放置隐藏目录树也无法修复它。