Python 修改Sphinx TOC树
我有一个带有TOC(Python 修改Sphinx TOC树,python,python-sphinx,Python,Python Sphinx,我有一个带有TOC(index.rst)的Sphinx项目,其中包括:maxdepth:2。问题是我想将release部分的深度减少到1,这样就不会在主目录中包含发行说明列表(列表太长) 似乎可以使用doctree-resolved事件处理程序修改TOC列表,但我不知道如何在事件处理程序中修改TOC树: from sphinx import addnodes def setup(app): def update_toctree(app, doctree, docname):
index.rst
)的Sphinx项目,其中包括: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)
也许这不是一个理想的解决方案,但在同一页面上使用多个
toctree
条目之前,我做过类似的工作,比如:
####################
Presto Documentation
####################
.. toctree::
:maxdepth: 2
overview
installation
.. toctree::
:maxdepth: 1
release
这并不理想,因为大多数主题都会在树之间添加额外的填充,但在我的例子中,这比为某些页面提供大量嵌套项列表要好。我找到了一个低技术解决方案:使用CSS隐藏最后一项的子项
div.toctree-wrapper > ul > li:last-child > ul {
display: none;
}
这是一个有趣的解决方案,但对我的情况没有帮助,因为我们使用“编号”,因此启动新的TOC将重置编号。遇到了与您相同的问题-我可以读取和修改TOC节点,但似乎无法保持更改。