更改Sphinx的目录模板。

Question

我是用Sphinx和我自己的模板来获得像twitter bootstrap文档一样的文档风格。http:/getbootstrap.com2.3.2getting-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会改变所有y需要的东西。