在reStructuredText中将TOC标题显示为标题（或完全隐藏它）

Question

我需要一个目录，用于我正在编辑的reStructuredText（.rst）文档，所以我添加了

.. contents:: Table of Contents

在适当的地方，它工作正常。

问题是，至少在GitHub的RST解析器/渲染器/无论如何，当我想要一个2级标题时，“目录”标题就像正常的非标题文本一样显示。

Here's the README.rst file我正在努力改变。请注意“目录”看起来不像节标题或标题。

有没有办法

1. 将TOC标题设置为2级标题或

2. 完全禁用TOC标题，所以我可以添加自己的标题？ （如下所示）

   Table of Contents
   -----------------
   .. contents:: :disable_title: true
   

Answer 1

您可以通过将:local: option与遗漏TOC标题相结合来禁用TOC标题：

Your h2 level title here
------------------------
.. contents::
   :local:

但请注意，本地选项将TOC本地化为仅列出其所在部分的子部分，而不是列出文档中的每个部分。如果您仍想要包含所有内容，请创建顶级标题并将TOC直接放在其下方。但是，这仍将排除顶级标题本身。