修改Sphinx TOC树

Modify Sphinx TOC tree(修改Sphinx TOC树)
本文介绍了修改Sphinx TOC树的处理方法,对大家解决问题具有一定的参考价值,需要的朋友们下面随着小编来一起学习吧!

问题描述

我有一个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树的文章就介绍到这了,希望我们推荐的答案对大家有所帮助,也希望大家多多支持编程学习网!

本站部分内容来源互联网,如果有图片或者内容侵犯您的权益请联系我们删除!

相关文档推荐

Leetcode 234: Palindrome LinkedList(Leetcode 234:回文链接列表)
How do I read an Excel file directly from Dropbox#39;s API using pandas.read_excel()?(如何使用PANDAS.READ_EXCEL()直接从Dropbox的API读取Excel文件?)
subprocess.Popen tries to write to nonexistent pipe(子进程。打开尝试写入不存在的管道)
I want to realize Popen-code from Windows to Linux:(我想实现从Windows到Linux的POpen-code:)
Reading stdout from a subprocess in real time(实时读取子进程中的标准输出)
How to call type safely on a random file in Python?(如何在Python中安全地调用随机文件上的类型?)