python - 无法在 Sphinx 中获取 TOCTREE 以显示链接

Question

我是狮身人面像的新手。我尝试了教程，但未能在内容中生成链接。我得到的错误

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.

我在 index.rst 所在的目录下创建了 zuhdi.rst 和 intro.rst。我怎样才能给文件加上标题？

供您引用，我的 index.rst 包含以下几行:

Contents:

.. toctree::
   :maxdepth: 2

   intro
   zuhdi

我是否必须存在这些文件才能将链接放入目录树中？ intro.rst 和 zuhdi.rst 只是一个空文件。

Answer 1

您收到此错误是因为您在 intro.rst 中没有标题。
为了解决这个问题，给 intro.rst 添加一个标题。假设您希望您的标题为 My Title，则可以通过将以下两行作为 intro.rst 的第一行来添加标题:

My Title
*********

请注意，您必须有足够的 * 个字符来完整地为您的标题添加下划线，否则您将收到另一个关于格式错误的标题或下划线的错误。