首页
学习
活动
专区
圈层
工具
发布
社区首页 >问答首页 >修改Sphinx TOC树

修改Sphinx TOC树
EN

Stack Overflow用户
提问于 2015-11-10 18:48:44
回答 2查看 1.5K关注 0票数 11

我有一个包含index.rst的狮身人面像项目,其中包括:maxdepth: 2。问题是,我希望将1部分的深度缩小到release部分,这样它就不会在主TOC中包含发行说明列表(列表太长)。

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

代码语言:javascript
复制
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)
EN

回答 2

Stack Overflow用户

回答已采纳

发布于 2015-11-27 09:16:01

我找到了一个低科技的解决方案:用CSS隐藏上一项的子项目。

代码语言:javascript
复制
div.toctree-wrapper > ul > li:last-child > ul {
  display: none;
}
票数 4
EN

Stack Overflow用户

发布于 2015-11-13 15:19:56

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

代码语言:javascript
复制
####################
Presto Documentation
####################

.. toctree::
    :maxdepth: 2

    overview
    installation

.. toctree::
    :maxdepth: 1

    release

这并不理想,因为大多数主题都会在树之间添加额外的填充,但在我的例子中,这比为某些页面拥有大量嵌套项列表要好得多。

票数 6
EN
页面原文内容由Stack Overflow提供。腾讯云小微IT领域专用引擎提供翻译支持
原文链接:

https://stackoverflow.com/questions/33637299

复制
相关文章

相似问题

领券
问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档