7

我正在更新一个相当大的项目的常见问题解答，我想在页面顶部添加问题索引，以便用户更容易找到他们正在寻找的内容。

Sphinx 文档toctree 文章指出“特殊条目名称 self 代表包含 toctree 指令的文档。如果您想从 toctree 生成“站点地图”，这很有用。” 这就是我要的。问题是 self 似乎坏了，只包括当前文档的标题而不是字幕。当我在另一个文档中并引用常见问题解答时，它可以正常工作，只有在文档本身中它才会失败。

展示

.. toctree::
   :maxdepth: 3

   faq

在其他文件中导致

  • 经常问的问题
    • 常问问题
      • 问题 1
      • 问题2
      • 问题 3
    • 不明显的行为和其他需要知道的

内部常见问题

.. toctree::
   :maxdepth: 3

   self

结果是

  • 经常问的问题

我认为这可能是因为 sphinx 在转换目录树并尝试将目录树移动到页面底部时不知道字幕。没变。

任何关于如何使用 sphinx 在页面本身中包含页面索引的想法将不胜感激

4

1 回答 1

9

您正在寻找的是内容指令。

在页面标题后插入以下块以构建问题列表：

.. contents::
   :local:
   :depth: 1

它将产生：

  • 问题 1
  • 问题2
  • 问题 3
于 2013-07-20T11:09:07.653 回答