我有一个Sphinx project,其中包含index.rst
的TOC(:maxdepth: 2
)。问题是我想将1
部分的深度减少到release
,以便它不包括主TOC中的发行说明列表(列表太长)。
似乎可以使用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)
答案 0 :(得分:6)
也许不是一个理想的解决方案,但在同一页面上使用多个toctree
条目之前我已做过类似的事情,例如:
####################
Presto Documentation
####################
.. toctree::
:maxdepth: 2
overview
installation
.. toctree::
:maxdepth: 1
release
它并不理想,因为大多数主题会在树之间添加额外的填充,但在我的情况下,这比为某些页面添加大量嵌套项更好。
答案 1 :(得分:4)
我发现了一种低技术解决方案:使用CSS隐藏最后一项的孩子。
div.toctree-wrapper > ul > li:last-child > ul {
display: none;
}