html - 更改 Sphinx 的目录模板

Question

我将 Sphinx 与我自己的模板一起使用，以获得类似 Twitter Bootstrap 文档的文档样式:http://getbootstrap.com/2.3.2/getting-started.html

您可以在左侧看到导航，它是静态的，在您滚动时停留在同一位置。

因此有必要渲染我已经用这个函数实现的目录:

{{ toctree(maxdepth=1, collapse=False, includehidden=true) }}

输出如下:

<ul class="current">
    <li class="toctree-l1 current"><a class="current reference internal" href="">Introduction</a></li>
    <li class="toctree-l1"><a class="reference internal" href="#installation">Installation</a></li>
    <li class="toctree-l1"><a class="reference internal" href="#roadmap">Roadmap</a></li>
</ul>

但为了让它与 bootstrap 一起工作，我需要以下输出:

<ul class="nav nav-list bs-docs-sidenav">
    <li><a href="#introduction"><i class="icon-chevron-right"></i> Introduction</a></li>
    <li><a href="#installation"><i class="icon-chevron-right"></i> Installation</a></li>
    <li><a href="#roadmap"><i class="icon-chevron-right"></i> Roadmap</a></li>
</ul>

所以我的问题是:我怎样才能做到这一点？是否有我可以调整的 toctree() 函数的模板文件？

Answer 1

我有一个类似的问题，我混合使用自定义角色和 jQuery 来根据我的角色定位来调整这个问题。 jQuery 将更改您需要的所有内容。