如何在Sphinx文档中的每个页面中添加目录?

时间:2012-03-09 17:44:58

标签: python documentation python-sphinx doc

我正在尝试复制ToC在此页面的侧边栏中的显示方式:http://matplotlib.sourceforge.net/sampledoc/extensions.html

...但我在模板本身找不到任何解释如何或“显示来源”的文档。

以下是他们在该教程中使用的模板源:http://matplotlib.sourceforge.net/sampledoc/custom_look.html

它叫:

{% block sidebar1 %}{{ sidebar() }}{% endblock %}

但这似乎不是ToC我的自定义文档。

更新:要回答我自己的问题,您只需要将子部分添加到同一页面,它就会将这些子部分自动生成为ToC。

1 个答案:

答案 0 :(得分:1)

答案(请参阅问题作者的更新)是,如果页面中有章节标题,则只能在侧栏中获得ToC。没有标题,根据斯芬克斯的说法,不需要ToC。