狮身人面像更改目录 HTML

Question

我正在对我的文档进行主题化，我正在尝试让 sphinx 向目录的 <ul> 元素添加一个类。不幸的是，看起来 HTML 的生成方式与任何其他列表相同。

有没有办法向 TOC 添加一个类？

我要添加的类 (fyi) 是 nav nav-tabs nav-stacked；我正在使用引导主题。

更新：我目前的技巧是覆盖 localtoc.html 模板以拥有

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

但是感觉很丑……

Answer 1

TOC 被单独转换为 HTML，然后插入到文档中，而无需您对其进行控制。查看sphinx.builds.html.StandaloneHTMLBuilder 的render_partial 方法。

您的 hack 是最简单的方法，另一种选择是继承 StandaloneHTMLBuilder 并覆盖 render_partial 以控制 docutils 的 HTMLWriter。