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

Question

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

我试过了

.. toc:: 

但这似乎没有任何影响:文档中没有插入任何内容.

基本上我需要链接到当前页面中的部分放置在每个页面的特定位置.

这可能吗？

Answer 1

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

更多细节在这里:http://docutils.sourceforge.net/docs/ref/rst/directives.html#table-of-contents

Answer 2

我有更多的运气：

.. contents:: Table of Contents
   :depth: 1
   :local:
   :backlinks: none

反向链接消除了从标题到目录的烦人链接。