仅在侧边栏中显示Sphinx toctree

Question

我是新手Sphinx用户，已经搜索了一段时间以寻找解决此问题的方法。

我的索引页面由index.rst创建，其中包含一个toctree。该页面在正文和侧边栏中显示TOC。我希望仅在侧边栏上显示TOC，并留出空间在每个页面正文中输入一些文本。特别地，主要的“欢迎来到我的地方”，目前的index.html和index.rst应该只是一个简短的段落而不是TOC。

我尝试过这个：

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

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

但这会将目录从页面和侧边栏中移除。 我该如何使其生效？

编辑： 这是它的显示方式，我希望目录仅出现在侧边栏中。 屏幕截图

- FT Support

---

Sphinx 2.2.11-id64-release (95ae9a6) sphinx-build 1.8.3 没有自定义主题，所以我假设它是sphinxdoc。 - FT Support

默认主题是白雪石。请参见http://www.sphinx-doc.org/en/master/usage/theming.html#builtin-themes。 - mzjn

是的，我正在使用雪花石膏。 - FT Support

我无法使用Alabaster重现这个问题。 - mzjn

Answer 1

你可以通过在 toctree 中包含单独的文件，并将 conf.py 文件中的变量 master_doc 指向该文件来实现此操作。

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

contents.rst

.. toctree::

   example

index.rst

# Landing Page
 Welcome!

- krm