我是新来的斯芬克斯。/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自动生成的结构取决于目录层次结构。
2条答案
按热度按时间6kkfgxo01#
我不认为这是一个支持的操作。
幸运的是,这也不是一个非常理想的方法,因为您通常希望文档的各个部分以特定的顺序出现。
qltillow2#
如果您愿意将所有源文件转储到
source
中,而不需要文件夹层次结构,那么这是可能的。或者,您可以编写一个例程,并在调用sphinx-build
之前从Makefile
运行它。正如Mike所提到的,
:glob:
只会按文件名的字母顺序拉取文件。看这里的文档。你可以在toctree指令中使用“globbing”,通过给glob标志选项。然后将所有条目与可用文档列表进行匹配,并按字母顺序将匹配项插入列表中。
如果您想使用
:glob:
并在source
中保持所有文件的顺序,则需要在.rst
文件前面加上数字。示例
当然,如果您决定希望文件以不同的顺序排列,而不是在
index.rst
中移动显式列表的顺序,您当然需要重命名文件。