用sphinx中的toctree创建一个sitemap似乎被破坏了吗？
用sphinx中的toctree创建一个sitemap似乎被破坏了吗？
提问于 2013-04-21 00:29:38
我正在为一个相当大的项目更新一个常见问题，我想在页面顶部添加一个问题索引，这样用户就可以更容易地找到他们想要的内容。
狮身人面像文档图科文章声明“特殊条目名self表示包含toctree指令的文档。如果您想从toctree生成一个”sitemap“，这是非常有用的。”这就是我想要的。问题是，self似乎已经崩溃，只包括当前的文档标题，而不包括字幕。当我在另一个文档中引用FAQ时，它正确工作，只有在文档本身中，它才会失败。
以示
.. toctree::
:maxdepth: 3
faq在其他文件中，结果是
- 常见问题
- 常见问题
- 问题1
- 问题2
- 问题3
- 常见问题
- Non-obvious behaviour and other need to know
内部常见问题
.. toctree::
:maxdepth: 3
self结果：
- 常见问题
我想可能是因为狮身人面像在转换图克树并试图将图克树移到页面底部时不知道字幕。没有变化。
任何关于如何将页面索引与狮身人面像一起包含在页面中的任何想法都将不胜感激。
回答 1
Stack Overflow用户
回答已采纳
发布于 2013-07-20 11:09:07
您要寻找的是目录指令。
在页面标题后插入以下块，以生成问题列表：
.. contents::
:local:
:depth: 1它将产生：
- 问题1
- 问题2
- 问题3
页面原文内容由Stack Overflow提供。腾讯云小微IT领域专用引擎提供翻译支持
原文链接：
https://stackoverflow.com/questions/16126747
复制相关文章
相似问题
腾讯云开发者
