使用Sphinx生成Python文档使用：glob：

Question

我是狮身人面像的新手。

文件/home/user/myproject/docs/source/index.rst是如下：

My project contents: 

.. toctree:: 
    :glob: 

    * 

我收到以下消息上运行/home/user/myproject/docs/下$ make html：

checking consistency... /home/user/myproject/docs/source/design/index.rst:: WARNING: document isn't included in any toctree 

我有什么错呢？我希望Sphinx根据目录层次自动生成结构。

Answer 1

我不认为这是一项支持的操作。

幸运的是，它不是一个非常理想的选择，因为您通常希望文档的某些部分以特定顺序显示。

Answer 2

如果你愿意只在source转储所有的源文件没有文件夹heirarchy，这是可能的。或者，您可以在致电sphinx-build之前编写例程并从Makefile运行它。

正如Mike所提到的，:glob:只会按文件名的字母顺序提取文件。 See the docs here。

通过给出glob标志选项，可以在toctree指令中使用“globbing”。然后将所有条目与可用文档列表进行匹配，并按字母顺序将匹配插入到列表中。

如果你想使用:glob:和维护source与您的所有文件排序，你需要用数字前缀您.rst文件。

例

source 
├── index.html 
├── 1_intro.rst 
├── 2_install.rst 
└── 3_more-than-you-want-to-know.rst 

虽然，你当然会需要的，如果你决定要命令他们不同，而不是在index.rst移动明确列表的顺序重命名这些文件。