如何将本地目录包含到Sphinx doc中?

时间:2014-06-09 21:36:21

标签: python documentation python-sphinx

如何将本地目录包含在Sphinx doc中?

我试过

.. toc:: 

但这似乎没有任何效果:文档中没有插入任何内容。

基本上我需要链接到当前页面中的各个部分放置在每个页面的某个位置。

这可能吗?

1 个答案:

答案 0 :(得分:37)

我不是100%确定这是你正在寻找的,但.. contents::指令可能有所帮助。默认情况下,无论您将指令放在何处,它都会为您提供整个页面的标题。如果指定了:local:,它将为您放置指令的下方标题生成本地TOC(对于子节tocs很方便)。

此处有更多详情:http://docutils.sourceforge.net/docs/ref/rst/directives.html#table-of-contents