带注释的狮身人面像toctree

Question

在Sphinx中toctree的通常用法如下所示：

.. toctree::
   :maxdepth: 2

   foo
   bar
   baz

例如，如果foo.rst以标题标题“Being Foo”开头，bar.rst以“执行栏”开头，baz.rst以“Thinking Baz”开头，那么你将得到一个很好的目录，如下所示：

• Being Foo
• Doing Bar
• Thinking Baz

从每个链接到相应的页面。

我的问题：有没有办法注释toctree？例如，如果我想用“W。Robert Foo”创建第一个metasyntactic变量之类的东西来注释“Being Foo”标题1857年，我们一直在使用它。“，然后我可以将该文本放在某处（希望在foo.rst的顶部，但如果没有，那么在toctree指令中）并且toctree输出看起来像这样：

• Being Foo - W. Robert Foo于1857年创建了第一个metasyntactic变量，从那时起我们就一直在使用它。
• Doing Bar
• Thinking Baz

Answer 1

您可以使用以下语法覆盖页面标题：

.. toctree::
   :maxdepth: 2

   Being Foo - W. Robert Foo created the first metasyntactic variable in 1857 <foo>
   bar
   baz

http://www.sphinx-doc.org/en/stable/markup/toctree.html?highlight=entries

然而，您将失去自动标题，这可能是您问题的主要部分？