使用javascript代替Sphinx的默认toctree

Question

我用狮身人面像自动生成html页面。目录非常长，所以我尝试在 toctree 的div中添加一个新的HTML类，这样我就可以使用javascript库，基本上是想改变toctree生成html的方式。

我找到了globaltoc.html文件，将它放在_templates文件夹中，并取消了conf.py中的template_path注释。

这是_templates目录中的文件。

{% extends '!globaltoc.html' %}

<div class="toctree-wrapper compound dhtmlxTree" id="toc", setImagePath="_static/imgs/csh_dhx_skyblue/">

{{ toctree() }}
</div>

如果我做错了，请告诉我另一种方法。我想在纯reST中做到这一点，但这似乎是不可能的。我看了关于狮身人面像模板的有限的例子，这是我所能找到的全部。

这样做的总体目标是将dhtmlxTree用于非常大的树。我已经在layout.html.中添加了所需的.js文件和.css文件我只需要包含toctree的div就可以得到我需要的类。我可以通过手工编辑得到我需要的结果，现在我需要自动化它。

谢谢你的帮助。

Answer 1

我相信对我的问题有两种可能的解决办法：

1. 使用Jinja模板编写javascript和项目符号列表。目前，我不熟悉使用递归的Jinja标志。因此，这个解决方案，虽然可能，可能会让我比第二个解决方案更沮丧。
2. 简单地减少：max纵深：属性用于toctree指令。它被设置为4。减少这个数目使目录更小，因此更容易阅读。

在考虑到需要看到所有的层次后，我意识到这是愚蠢的，它降低了目录的有用性。因此，我只是将：max纵深：简化为2，一切都回到了reST和狮身人面像所提供的简单性。

更好的设计每次都胜过酷的因素。