Sphinx 更改目录 HTML

Question

我正在为我的文档设计主题，想让sphinx在目录的

元素上添加一个类。不过，生成的HTML看起来和其他列表没什么区别。

有没有办法给目录添加一个类呢？

我想添加的类是

，因为我在用一个bootstrap主题。

更新：我现在的解决办法是覆盖localtoc.html模板，内容是

{{ toc|replace("<ul>", "<ul class='nav nav-tabs nav-stacked'>") }}

但是这样做感觉不太好...

Answer 1

目录（TOCs）是单独转换成HTML格式的，然后再插入到文档里，这个过程你无法控制。可以看看 sphinx.builds.html.StandaloneHTMLBuilder 里的 render_partial 方法。

你提到的这个方法是最简单的，另外一个选择是创建一个 StandaloneHTMLBuilder 的子类，并重写 render_partial 方法，这样你就可以控制文档工具的 HTMLWriter 了。