python - 狮身人面像更改目录 HTML

Question

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

有没有办法在 TOC 中添加一个类？

我要添加的课程（仅供参考）是nav nav-tabs nav-stacked；我正在使用引导主题。

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

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

但是感觉很丑。。。

Answer 1

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

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