修改 Sphinx TOC 树

Question

我有一个 Sphinx 项目，其目录 (index.rst) 包括 :maxdepth: 2。问题是我想将 release 部分的深度减少到 1，这样它就不会在主目录中包含发行说明列表（列表太长）。

似乎可以使用 doctree-resolved 事件处理程序修改 TOC 列表，但我不知道如何在事件处理程序中修改 TOC 树：

from sphinx import addnodes

def setup(app):
    def update_toctree(app, doctree, docname):
        if docname != 'index':
            return

        node = doctree.traverse(addnodes.toctree)[0]
        toc = app.env.resolve_toctree(docname, app.builder, node)

        # do something with "toc" here

    app.connect('doctree-resolved', update_toctree)

Answer 1

也许不是一个理想的解决方案，但在同一页面上使用多个 toctree 条目之前，我已经做过类似的事情，例如：

####################
Presto Documentation
####################

.. toctree::
    :maxdepth: 2

    overview
    installation

.. toctree::
    :maxdepth: 1

    release

这并不理想，因为大多数主题会在树之间添加额外的填充，但在我的情况下，这比为某些页面使用大量嵌套项目要好。

Answer 2

我找到了一个低技术含量的解决方案：使用 CSS 隐藏最后一项的子项。

div.toctree-wrapper > ul > li:last-child > ul {
  display: none;
}

修改 Sphinx TOC 树

Modify Sphinx TOC tree

python

python-sphinx