Sphinx在目录中未显示本地标题

时间:2019-05-29 20:07:55

标签: python-sphinx restructuredtext tableofcontents

使用默认设置(包括Alabaster主题)生成sphinx文档时,TOC侧栏仅显示整个文档的顶级标题。它用来显示当前页面的第二级以上标题。我该如何解决?

(注意:IIRC以前受globaltoc.html中是否包含localtoc.htmlhtml_sidebars的影响,但似乎在Alabaster和/或最新版本中都没有,存在。)

1 个答案:

答案 0 :(得分:0)

事实证明,这是由于生成新的Sphinx项目时的愚蠢且易于忽略的默认设置。具体来说,默认目录如下:

.. toctree::
    :maxdepth: 1
    :caption: Contents:

    overview
    topic1
    topic2
    ...

问题是maxdepth。事实证明,这不仅控制将显示在索引页正文中的目录中显示的标题级别的数量,而且显示在侧边栏中的本地目录深度。显然,新项目的maxdepth为1,这意味着将看不到本地目录。