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

2022-04-21 00:00:00 python python-sphinx toctree

问题描述

我是新来的斯芬克斯。我尝试了该教程,但未能在内容中生成链接。我收到的错误

C:Usersmhaikalmsphinxtestsourceindex.rst:11: WARNING: toctree contains refe
rence to document 'intro' that doesn't have a title: no link will be generated
C:Usersmhaikalmsphinxtestsourceindex.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.rstintro.rst。如何为文档添加标题?

仅供参考,My index.rst包含以下行:

Contents:

.. toctree::
   :maxdepth: 2

   intro
   zuhdi
是否必须存在文档才能将链接放入目录树中?intro.rstzuhdi.rst只是一个空文件。


解决方案

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

My Title
*********

请注意,您必须有足够的*个字符来为您的书目添加完整的下划线,否则您将收到有关错误的书目或其下划线的另一个错误。

相关文章