如何在Sphinx中展开侧栏Toctree上的所有子部分?

问题描述

我想知道是否有办法展开index.rst文件中包含的标题下的所有子部分?

作为示例,它是这样的:

Section 1
Section 2
Section 3

我希望是这样的:

Section 1
  Subsection 1.1
  Subsection 1.2
  Subsection 1.3
Section 2
  Subsection 2.1
  Subsection 2.2
  Subsection 2.3
Section 3
  Subsection 3.1
  Subsection 3.2
  Subsection 3.3
如果我单击第1节,它会显示它下面的内容,但如果我单击第2节,则会隐藏第1节的内容,只显示第2节。我希望所有2节被扩展每次我在索引页上。我已尝试添加toctreemaxdepth,但均不起作用。


解决方案

我在试图读取狮身人面像源代码时丢失了大约340万个神经元(它是由一群狂热而鲁莽的浣熊编写的吗?)如此多的抽象级别)。

所以:

  • 制作自己的狮身人面像主题(使用第三方主题作为基础,非常容易。我使用了‘可读’主题)
  • 在您有heme.conf的目录中,添加一个"fulltoc.html"模板,其中包含一行:

fulltoc.html:

{{ toctree(collapse=False) }}

(嘿,注意到‘坍塌’参数了吗?)

  • 在sphinx conf.py中,修改html_siidears选项以添加模板;并声明您的主题

conf.py:

html_theme_path = [customized_readable_theme.get_html_theme_path()]
html_theme = 'customized_readable'
html_sidebars = {'**': ['fulltoc.html', 'relations.html', 'sourcelink.html', 'searchbox.html']}
  • 重建文档

相关文章