Sphinx toctree明确标题

时间:2012-11-16 18:59:00

标签: python python-sphinx

我试图在我的toctree中明确设置元素的标题。文档说它应该是这个

.. toctree::

    All about strings <string>

但它只是在string.rst文档中打印出什么标题,而不是“All about strings”

有人有想法吗?

2 个答案:

答案 0 :(得分:1)

我可以用Sphinx 1.1.2确认这一点。这似乎是一个错误,可能是issue #86的回归。这个问题在0.5.2中显然已得到解决,但似乎已经找回了原因。

答案 1 :(得分:1)

根据Lukas Graf的回答,sphinx 1.1.2确实存在问题。我用1.1.3试了一下:没问题。 (在python 2.7,osx上)。

我在Sphinx' 1.1.3 changelog中没有看到任何具体内容,尽管提到“恢复与docutils trunk的兼容性”。这表明另一个docutils版本可以帮助您。我正在使用版本0.9

所以:sphinx 1.1.3和docutils 0.9,您可以尝试这些版本吗?