python-sphinx - 仅在侧边栏中的 Sphinx toctree

Question

我是 Sphinx 的新手，并且一直在寻找这个问题的解决方案。

我的索引页是由 index.rst 制作的，其中包含一个目录树。该页面在正文和侧边栏中显示 TOC。我只想在侧边栏上显示目录，而不是在每个页面正文中输入一些文本。特别是主要的“Welcome to My Place”，目前index.html和index.rst应该只是一段blurb而不是TOC。

我试过这个:

Welcome to My Place
==================

.. toctree::
   :hidden:
   :maxdepth: 2
   :caption: Contents:

但这会从页面和侧边栏中删除 TOC。
我怎样才能让它发挥作用？

编辑:
这是它的显示方式，我希望 TOC 仅出现在侧边栏中。
Screen shot

Answer 1

您可以通过为 toctree 包含一个单独的文件来做到这一点。并指向变量 master_doc在 conf.py 到这个文件。
conf.py

# ...
master_doc = "contents"
# ...rest of the document

contents.rst

.. toctree::

   example

index.rst

# Landing Page
 Welcome!