无法让斯芬克斯中的TOCTREE显示链接。

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

我是Sphinx的新手。我尝试了一下教程,但我未能在内容中生成链接。我得到的错误是

C:\Users\mhaikalm\sphinxtest\source\index.rst:11: WARNING: toctree contains refe
rence to document 'intro' that doesn't have a title: no link will be generated
C:\Users\mhaikalm\sphinxtest\source\index.rst:11: WARNING: toctree contains refe
rence to document 'zuhdi' that doesn't have a title: no link will be generated
writing additional files... (0 module code pages) genindex search
copying static files... done
dumping search index... done
dumping object inventory... done
build succeeded, 3 warnings.

Build finished. The HTML pages are in build/html.

我已经创建了 zuhdi.rstintro.rst 在同一目录下 index.rst. 我如何给文件加上标题?

我的index.rst包含了这几行。

Contents:

.. toctree::
   :maxdepth: 2

   intro
   zuhdi

文件是否必须存在,我才能把链接放到树上?我的index.rst中包含了以下几行内容:文件必须存在吗?intro.rstzuhdi.rst 只是一个空文件。

python python-sphinx toctree
1个回答
26
投票

你得到这个错误是因为你的内容中没有标题。intro.rst. 为了解决这个问题,请在标题中加入 intro.rst. 假设你希望你的标题是 My Title然后,可以将下面两行作为第一行来添加标题。intro.rst:

My Title
*********

注意,你必须有足够的 * 字符完全划线的标题,否则你会得到另一个错误的标题或下划线的标题

希望能帮到你

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