Question

我是Sphinx的新手。

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

My project contents:

.. toctree::
   :glob:

   *

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

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

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

Answer 1

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

幸运的是，它也不是一个非常理想的选择，因为您通常希望文档的各个部分按特定顺序出现。

Answer 2

如果您愿意在没有文件夹层次结构的情况下将所有源文件转储到source，这是可能的。或者，您可以编写例程并在调用Makefile之前从sphinx-build运行它。

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

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

如果您想使用:glob:并维护source中所有文件的排序，则需要在.rst个文件前加上数字。

示例

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

但是，如果您决定要以不同方式排序文件，而不是在index.rst中移动显式列表的顺序，您当然需要重命名文件。

使用Sphinx生成Python文档：glob：

2 个答案: