我正在为一个相当大的项目更新一个FAQ，我想在页面顶部添加问题的索引，这样用户就可以更轻松地找到他们想要的东西。
Sphinx文档toctree article指出：“特殊条目名称self代表包含toctree指令的文档。如果要从toctree生成“ sitemap”，这将很有用。”这就是我要的。问题在于self似乎已损坏，仅包含当前文档标题，而没有副标题。当我在另一个文档中并引用FAQ时，它可以正常工作，只有在文档本身中它才会失败。
展示
.. toctree::
:maxdepth: 3
faq
在其他文件中导致
经常问的问题
常问问题
问题1
问题2
问题3
非显而易见的行为和其他需要知道的
内部常见问题
.. toctree::
:maxdepth: 3
self
结果是
经常问的问题
我以为可能是因为在转换toctree时，sphinx并不了解字幕，并尝试将toctree移到页面底部。没变。
任何关于如何使用狮身人面像在页面本身中包含页面索引的想法将不胜感激
最佳答案
您正在寻找的是contents指令。
在页面标题之后插入以下代码块以构建问题列表：
.. contents::
:local:
:depth: 1
它将产生：
问题1
问题2
问题3