仅侧边栏中的Sphinx toctree

Question

我刚接触Sphinx，已经寻找这个问题的解决方案有一段时间了。

我的索引页是由index.rst制作的，它包含一个目录树。页面在正文和侧边栏中显示TOC。我只想在侧边栏上显示TOC，在每个页面主体中留出空间来输入一些文本。特别是主要的“欢迎来到我的地方”，目前的index.html和index.rst应该只是一段内容简介而不是目录。

我已经尝试过了：

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

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

但这会将TOC从页面和侧边栏中删除。我怎么才能让它工作呢？

编辑:这是它的外观，我希望TOC只出现在侧边栏中。Screen shot

Answer 1

为此，您可以为toctree包含一个单独的文件，并将conf.py中的变量master_doc指向此文件。

conf.py

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

contents.rst

.. toctree::

   example

index.rst

# Landing Page
 Welcome!