Sphinx 侧边栏中的部分标题

Question

有什么方法可以在 Sphinx 文档的左侧菜单中添加章节标题吗？我知道如果你使用 MkDocs（例如 here），你可以做到这一点，但是有没有办法在 Sphinx 和 ReSTructured 文本中做到这一点？

我想将我的文档分成不同的部分（例如安装说明、运行程序等），这些部分的标题在左侧菜单中显示为文本。

Answer 1

在conf.py中更新html_sidebars如下：

html_sidebars = {'**': ['localtoc.html']}

Answer 2

终于想出了如何在 Sphinx 中完成...

有一个 :caption: 指令允许您向 table 内容添加标题。例如，readthedocs 的内容 table 如下所示：

.. toctree::
   :maxdepth: 2
   :caption: User Documentation # <-- This is what I was looking for

   getting_started
   versions
   [...]

:caption: User Documentation 将 "User Documentation" 部分 header 添加到边栏：

我不知道为什么标题后面有这么多wite-space，但我想这只是主题的问题...

Section titles in the Sphinx sidebar