修改Sphinx TOC树 [英] Modify Sphinx TOC tree

问题描述

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

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

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)

推荐答案

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

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

这篇关于修改Sphinx TOC树的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持IT屋！